Fix v0.1.0 issues identified by reviewers
Closed this issue · 1 comments
-
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") -
\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{}
. -
Instead of
cat()
rather usemessage()
/warning()
orif(verbose)cat(..)
(or maybestop()
) if you really have to write text to the console (except for print, summary, interactive functions). -
You are setting
options(warn=-1)
in your function. This is not allowed. -
Please always make sure to reset to user's options(), working directory or
par()
after you changed it in examples and vignettes and demos. -> inst/doc/GraphicalMultiplicity.R, e.g.:
old <- options(scipen = 999)
...
options(old)
It looks like all identified issues are now resolved, so I'm closing this.