Giters

jhrcook / mustashe

A system for stashing and loading the results of long running computations.

Home Page:https://jhrcook.github.io/mustashe/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CRAN submission comments

jhrcook opened this issue · comments

commented

The following are the comments from CRAN after the first submission attempt:

  1. Please omit the redundant "in R" from the title.
  2. 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)
  3. \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.
  4. Please do not modifiy the .GlobalEnv. This is not allowed by the CRAN policies.
commented

These are being addressed in the cran-submission-comments branch.

My comments:

  1. Easy change to documentation.
  2. Easy changes to documentation.
  3. Change to documentation that may be a bit tricky to resolve.
  4. I do not know how to get around this one, but I have reached out to the maintainer of 'ProjectTemplate' for advice.
commented

Kenton White, the maintainer of 'ProjectTemplate', replied to my query:

We were grandfathered in before CRAN started the policy of not modifying the .GlobalEnv. I have had challenges with CRAN and have found that if I make a well reasoned argument why it must be done this way they can be persuaded. Sometimes they have a better suggestion than what I was thinking!

I will take his advice and add some comments to the cran-comments.md file.