pharmaverse/tidytlg

CRAN Submission Issues

Closed this issue · 0 comments

Received the following feedback from CRAN:

Please always write package names, software names and API (application programming interface) names in single quotes in title and description. e.g: --> 'tidyverse'
Please note that package names are case sensitive.

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) arXiv:...
authors (year, ISBN:...)
or if those are not available: https:...
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for auto-linking.
(If you want to add a title as well please put it in quotes: "Title")

The LICENSE file is only needed if you have additional restrictions to the license which you have not? In that case omit the file and its reference in the DESCRIPTION file.

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:
statlist.Rd: \value

You have examples for unexported functions. Please either omit these examples or export these functions.
Examples for unexported function
roundSAS() in:
roxygen2_data.Rd

Some code lines in examples are commented out.
Please never do that. Ideally find toy examples that can be regularly executed and checked. Lengthy examples (> 5 sec), can be wrapped in \donttest{}.
Examples in comments in:
tlgsetup.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.
Does not seem necessary.
Please unwrap the examples if they are executable in < 5 sec, or replace \dontrun{} with \donttest{}.