Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cran comments #17

Merged
merged 2 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/R-CMD-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ jobs:

- uses: r-lib/actions/check-r-package@v2
with:
error-on: '"note"'
error-on: '"note"'
run_dont_test: true
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# parcats 0.0.5
* update vignette
* fix documentation
* fix examples

# parcats 0.0.4
* updated package dependencies
Expand Down
23 changes: 13 additions & 10 deletions R/parcats.R
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ get_shapes = function(traces){
#'@details most parameters are best left at default values
#' @examples
#'
#'\dontrun{
#'\donttest{
#'library(easyalluvial)
#'
#' # alluvial wide ---------------------------------
Expand All @@ -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}}
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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")
Expand Down
24 changes: 24 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions man/parcats-shiny.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 11 additions & 9 deletions man/parcats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/parcats_demo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading