Merge pull request #17 from erblast/cran

Cran comments

.github/workflows/R-CMD-check.yml

@@ -32,4 +32,5 @@ jobs:
 
       - uses: r-lib/actions/check-r-package@v2
         with:
-          error-on: '"note"'
+          error-on: '"note"'
+          run_dont_test: true

NEWS.md

@@ -1,5 +1,7 @@
 # parcats 0.0.5
 * update vignette
+* fix documentation
+* fix examples
 
 # parcats 0.0.4
 * updated package dependencies

R/parcats.R

@@ -580,7 +580,7 @@ get_shapes = function(traces){
 #'@details most parameters are best left at default values
 #' @examples
 #' 
-#'\dontrun{
+#'\donttest{
 #'library(easyalluvial)
 #'
 #' # alluvial wide ---------------------------------
@@ -590,15 +590,17 @@ get_shapes = function(traces){
 #'
 #' parcats(p, marginal_histograms = TRUE, data_input = mtcars2)
 #' 
-#' # alluvial for model response --------------------
-#' df = mtcars2[, ! names(mtcars2) %in% 'ids' ]
-#' m = randomForest::randomForest( disp ~ ., df)
-#' imp = m$importance
-#' dspace = get_data_space(df, imp, degree = 3)
-#' pred = predict(m, newdata = dspace)
-#' p = alluvial_model_response(pred, dspace, imp, degree = 3)
+#' if(check_pkg_installed("randomForest", raise_error = FALSE)) {
+#'   # alluvial for model response --------------------
+#'   df = mtcars2[, ! names(mtcars2) %in% 'ids' ]
+#'   m = randomForest::randomForest( disp ~ ., df)
+#'   imp = m$importance
+#'   dspace = get_data_space(df, imp, degree = 3)
+#'   pred = predict(m, newdata = dspace)
+#'   p = alluvial_model_response(pred, dspace, imp, degree = 3)
 #'
-#' parcats(p, marginal_histograms = TRUE, imp = TRUE, data_input = df)
+#'   parcats(p, marginal_histograms = TRUE, imp = TRUE, data_input = df)
+#' }
 #'}
 #'
 #'@seealso \code{\link[easyalluvial]{alluvial_wide}}
@@ -776,7 +778,7 @@ parcats <- function(p, marginal_histograms = TRUE, data_input = NULL
 #'   is useful if you want to save an expression in a variable.
 #'
 #' @name parcats-shiny
-#'
+#' @return No return value, called for side effects
 #' @export
 parcatsOutput <- function(outputId, width = '100%', height = '100%', inline = FALSE){
   htmlwidgets::shinyWidgetOutput(outputId
@@ -804,6 +806,7 @@ render_parcats <- function(expr, env = parent.frame(), quoted = FALSE) {
 #' }
 #' @rdname parcats_demo
 #' @export 
+#' @return No return value, called for side effects
 parcats_demo <- function() {
 
   easyalluvial::check_pkg_installed("shiny")

cran-comments.md

@@ -1,3 +1,27 @@
+# Resubmission
+
+
+Please add \value to .Rd files regarding exported methods and explain
+the functions results in the documentation. Please write about the
+structure of the output (class) and also what the output means. (If a
+function does not return a value, please document that too, e.g.
+\value{No return value, called for side effects} or similar)
+Missing Rd-tags:
+      parcats-shiny.Rd: \value
+      parcats_demo.Rd: \value
+
+\dontrun{} should only be used if the example really cannot be executed
+(e.g. because of missing additional software, missing API keys, ...) by
+the user. That's why wrapping examples in \dontrun{} adds the comment
+("# Not run:") as a warning for the user. Does not seem necessary.
+Please replace \dontrun with \donttest.
+Please unwrap the examples if they are executable in < 5 sec, or replace
+dontrun{} with \donttest{}.
+-> man/parcats.Rd
+
+- return value was added
+- switched to donttest
+- conditional execution of parcats example that requires suggested package
 
 # parcats 0.0.5
 Resubmit to CRAN after being archived.