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

CRAN requested changes for 0.1.0 #13

Closed
nx10 opened this issue Jan 23, 2024 · 0 comments
Closed

CRAN requested changes for 0.1.0 #13

nx10 opened this issue Jan 23, 2024 · 0 comments

Comments

@nx10
Copy link
Owner

nx10 commented Jan 23, 2024

Please always write package names, software names and API (application
programming interface) names in single quotes in title and description.
e.g: --> 'C'
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")

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

\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.
Please replace \dontrun with \donttest if possible.

Please fix 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

No branches or pull requests

1 participant