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

Fix CRAN review comments #16

Closed
nealhaddaway opened this issue Jul 9, 2021 · 3 comments · Fixed by #17
Closed

Fix CRAN review comments #16

nealhaddaway opened this issue Jul 9, 2021 · 3 comments · Fixed by #17
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nealhaddaway
Copy link
Collaborator

We've received the following response from manual inspection on CRAN:

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

Functions which are supposed to only run interactively (e.g. shiny)
should be wrapped in if(interactive()).
Please replace /dontrun{} with if(interactive()){} if possible,
then users can see that the functions are not intended for use in
scripts / functions that are supposed to run non interactively.

@nealhaddaway
Copy link
Collaborator Author

Not sure I understand these... @chriscpritchard

@chriscpritchard chriscpritchard self-assigned this Jul 9, 2021
@chriscpritchard chriscpritchard added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 9, 2021
@chriscpritchard
Copy link
Collaborator

Doesn't look too tricky, I'll take a peek over the weekend.

@nealhaddaway
Copy link
Collaborator Author

nealhaddaway commented Jul 9, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants