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

Feedback from CRAN after 1.0.0 submission #190

Closed
PatrickRWright opened this issue Apr 6, 2020 · 0 comments · Fixed by #191
Closed

Feedback from CRAN after 1.0.0 submission #190

PatrickRWright opened this issue Apr 6, 2020 · 0 comments · Fixed by #191

Comments

@PatrickRWright
Copy link
Collaborator

PatrickRWright commented Apr 6, 2020

DESCRIPTION: ✔️
Please always write package names, software names and API names in
single quotes in title and description. e.g: --> 'secuTrial'

README.Rmd:* ✔️
Found the following (possibly) invalid file URI:
URI: vignettes/secuTrialR-package-vignette.pdf
From: README.md

completeness.R: ✔️
Found the following \keyword or \concept entries
which likely give several index terms:
File 'form_status_counts.Rd':
\keyword{status,}
File 'form_status_summary.Rd':
\keyword{status,}
I think you just need to omit the comma.

tests/testthat: (add skip_on_cran() for all tests) ✔️
Flavor: r-devel-windows-ix86+x86_64
Check: Overall checktime, Result: NOTE
Overall checktime 18 min > 10 min

A CRAN package check should not take longer than 10 minutes. Please
considerably reduce the check time of your package to stay below the
threshold of 10 minutes. This can for example be achieved by:

  • Omitting the less important and lengthy tests by only running them
    conditionally if some environment variable is set that you only define
    on your machine.

  • Using precomputed results for the computational intensive parts in
    vignettes.

Ensure that even after this change the package still includes
illustrative examples of the use of the user-facing functions. Please
aim at trying to test and also illustrate the use of as much
functionality of the package as possible while making considerate use
of the computational resources.

DESCRIPTION: ✔️
Please do not start the description with "This package", package name,
title or similar.

DESCRIPTION: ✔️
Please add a web reference for secuTrial in the form <[https:.....]https:.....> to
the description of the DESCRIPTION file with no space after 'https:' and
angle brackets for auto-linking.

DESCRIPTION: ✔️ ref
Please always add all authors, contributors and copyright holders in the
Authors@R field with the appropriate roles.
From CRAN policies you agreed to:
"The ownership of copyright and intellectual property rights of all
components of the package must be clear and unambiguous (including from
the authors specification in the DESCRIPTION file). Where code is copied
(or derived) from the work of others (including from R itself), care
must be taken that any copyright/license statements are preserved and
authorship is not misrepresented.
Preferably, an ‘Authors@R’ would be used with ‘ctb’ roles for the
authors of such code. Alternatively, the ‘Author’ field should list
these authors as contributors.

DESCRIPTION: (contact iAS) ✔️
Where copyrights are held by an entity other than the package authors,
this should preferably be indicated via ‘cph’ roles in the ‘Authors@R’
field, or using a ‘Copyright’ field (if necessary referring to an
inst/COPYRIGHTS file)."
e.g.: secuTrial
Please explain in the submission comments what you did about this issue.

assess_form_variable_completeness.R: ✔️
You have examples for unexported functions which cannot run in this way.
Please either add packagename::: to the function calls in the examples,
omit these examples or export these functions.

check @return statements in roxygen2 docu: ✔️
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)

links_secuTrial.R: ✔️
\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{}.

visit_structure.R: ✔️
Please do not modifiy the .GlobalEnv. This is not allowed by the CRAN
policies.

You have

old.par <- par()
on.exit(old.par)

in R/visit_structure.R but this will produce warnings

You need:

old.par <- par(no.readonly = TRUE)
on.exit(par(old.par))

secuTrialR-package-vignette.Rmd: ✔️
Please do not modify the user's global environment or the user's home
filespace in your examples or vignettes by deleting objects
rm(list = ls())

README.Rmd: ✔️
You are using installed.packages() in your code. As mentioned in the
notes of installed.packages() help page, this can be very slow:
"This can be slow when thousands of packages are installed, so do not
use this to find out if a named package is installed (use system.file or
find.package) nor to find out if a package is usable (call require and
check the return value) nor to find details of a small number of
packages (use packageDescription). It needs to read several files per
installed package, which will be slow on Windows and on some
network-mounted file systems." [installed.packages() help page]
Please do not use installed.packages().

Please adapt accordingly and resubmit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant