CRAN first release (#67)

* Add NEWS.md

* version and doc updates

* add return value to Rd file

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", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2402-136X")),

NEWS.md

@@ -0,0 +1,3 @@
+# shinymodels 0.1.0
+
+* First CRAN release

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)
 #'

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)
 }

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
 

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:

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: