Skip to content

CRAN Feedback #4

@coatless

Description

@coatless

Received Fri, Jan 17, 4:00 AM

Please always write package names, software names and API (application
programming interface) names in single quotes in title and description.
e.g: --> 'quarto', 'shinylive', 'shiny'
Please note that package names are case sensitive.
For more details:
https://contributor.r-project.org/cran-cookbook/description_issues.html#formatting-software-names

If there are references describing the methods in your package, please
add these in the description field of your DESCRIPTION file in the form
authors (year) doi:...
authors (year, ISBN:...)
or if those are not available: https:...
with no space after 'doi:', 'https:' and angle brackets for
auto-linking. (If you want to add a title as well please put it in
quotes: "Title")
For more details:
https://contributor.r-project.org/cran-cookbook/description_issues.html#references

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)
For more details:
https://contributor.r-project.org/cran-cookbook/docs_issues.html#missing-value-tags-in-.rd-files
-> Missing Rd-tags:
print.quarto_shinylive_apps.Rd: \value
print.standalone_shinylive_app.Rd: \value

You have examples for unexported functions. Please either omit these
examples or export these functions. -> Warning: Examples for unexported
function
find_shinylive_app_json() in:
find_shinylive_app_json.Rd
find_shinylive_code() in:
find_shinylive_code.Rd
parse_code_block() in:
parse_code_block.Rd
parse_yaml_options() in:
parse_yaml_options.Rd
print() in:
validate_app_json.Rd
print.standalone_shinylive_app() in:
write_apps_to_dirs.Rd
print() in:
write_apps_to_quarto.Rd
validate_app_json() in:
write_file_content.Rd
write_apps_to_dirs() in:
write_standalone_shinylive_app.Rd

\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. Please replace \dontrun with
\donttest where possible.

Please unwrap the examples if they are executable in < 5 sec, or replace
dontrun{} with \donttest{}.

For more details:
https://contributor.r-project.org/cran-cookbook/general_issues.html#structuring-of-examples

Please ensure that your functions do not write by default or in your
examples/vignettes/tests in the user's home filespace (including the
package directory and getwd()). This is not allowed by CRAN policies.
Please omit any default path in writing functions. In your
examples/vignettes/tests you can write to tempdir().
For more details:
https://contributor.r-project.org/cran-cookbook/code_issues.html#writing-files-and-directories-to-the-home-filespace
-> R/writers.R
Please fix and resubmit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions