From 831c310343f9a50968bbdadf7364f32e9111eee8 Mon Sep 17 00:00:00 2001 From: Max Kuhn Date: Thu, 18 Nov 2021 18:24:34 -0500 Subject: [PATCH] CRAN first release (#67) * Add NEWS.md * version and doc updates * add return value to Rd file --- DESCRIPTION | 2 +- NEWS.md | 3 +++ R/explore.R | 1 + R/organize_data.R | 5 +++-- R/shiny_models.R | 1 + README.Rmd | 4 ++-- README.md | 6 +++--- man/explore.Rd | 3 +++ man/print.shiny_data.Rd | 5 ++++- man/shiny_models.Rd | 3 +++ 10 files changed, 24 insertions(+), 9 deletions(-) create mode 100644 NEWS.md diff --git a/DESCRIPTION b/DESCRIPTION index b254fea..b902e70 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: shinymodels Title: Interactive Assessments of Models -Version: 0.0.1 +Version: 0.1.0 Authors@R: c( person("Max", "Kuhn", , "max@rstudio.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-2402-136X")), diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..8c0180a --- /dev/null +++ b/NEWS.md @@ -0,0 +1,3 @@ +# shinymodels 0.1.0 + +* First CRAN release diff --git a/R/explore.R b/R/explore.R index 8de152e..1b6318a 100644 --- a/R/explore.R +++ b/R/explore.R @@ -63,6 +63,7 @@ generics::explore #' tuning parameter combinations that were fully resampled. As a result, #' parameter combinations that were discarded during the race will now be able #' to be selected. +#' @return A shiny application. #' @examples #' data(ames_mlp_itr) #' diff --git a/R/organize_data.R b/R/organize_data.R index 6112aa7..d574e55 100644 --- a/R/organize_data.R +++ b/R/organize_data.R @@ -134,7 +134,8 @@ get_app_type <- function(y) { #' #' This is a print method for a shiny_data class #' @param x an object of class shiny_data -#' @param ... Other parameters not currently used +#' @param ... Other parameters not currently used. +#' @return `x` invisibly. #' @keywords internal #' @export print.shiny_data <- function(x, ...) { @@ -146,5 +147,5 @@ print.shiny_data <- function(x, ...) { paste("tuning parameters:", .get_tune_parameter_names(x$tune_results)), sep = "\n" ) - cat(string) + invisible(x) } diff --git a/R/shiny_models.R b/R/shiny_models.R index 7a7dba7..0043b70 100644 --- a/R/shiny_models.R +++ b/R/shiny_models.R @@ -14,6 +14,7 @@ #' data sets. #' @param original_data Original dataset. #' @param ... Other parameters not currently used. +#' @return A shiny application. #' @export #' @keywords internal diff --git a/README.Rmd b/README.Rmd index f43fd97..83678a3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -24,10 +24,10 @@ The goal of shinymodels is to launch a Shiny app given tidymodels' tuning or res ## Installation -~~You can install the released version of shinymodels from [CRAN](https://CRAN.R-project.org) with:~~ +You can install the released version of shinymodels from [CRAN](https://CRAN.R-project.org) with: ``` r -install.packages("shinymodels") ## not yet +install.packages("shinymodels") ``` And the development version from [GitHub](https://github.com/) with: diff --git a/README.md b/README.md index d48ceeb..e73bae3 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,11 @@ results. ## Installation -~~You can install the released version of shinymodels from -[CRAN](https://CRAN.R-project.org) with:~~ +You can install the released version of shinymodels from +[CRAN](https://CRAN.R-project.org) with: ``` r -install.packages("shinymodels") ## not yet +install.packages("shinymodels") ``` And the development version from [GitHub](https://github.com/) with: diff --git a/man/explore.Rd b/man/explore.Rd index e606dc5..30e9cab 100644 --- a/man/explore.Rd +++ b/man/explore.Rd @@ -26,6 +26,9 @@ if they are enclosed with in \code{c()}. points is enabled (the default) or not. This can be helpful for very large data sets.} } +\value{ +A shiny application. +} \description{ \code{explore()} launches a Shiny application to interact with results from some tidymodels functions. diff --git a/man/print.shiny_data.Rd b/man/print.shiny_data.Rd index 4be7b6a..1513326 100644 --- a/man/print.shiny_data.Rd +++ b/man/print.shiny_data.Rd @@ -10,7 +10,10 @@ \arguments{ \item{x}{an object of class shiny_data} -\item{...}{Other parameters not currently used} +\item{...}{Other parameters not currently used.} +} +\value{ +\code{x} invisibly. } \description{ This is a print method for a shiny_data class diff --git a/man/shiny_models.Rd b/man/shiny_models.Rd index 9c2fc92..4a7b5a1 100644 --- a/man/shiny_models.Rd +++ b/man/shiny_models.Rd @@ -38,6 +38,9 @@ data sets.} \item{original_data}{Original dataset.} } +\value{ +A shiny application. +} \description{ This function takes the \code{\link[=organize_data]{organize_data()}} result to shiny_models a Shiny app. }