Skip to content

Address CRAN comments #69

Open
Open
@statnmap

Description

@statnmap

Validation criteria

  • No Missing Rd-tags for pipe.Rd: \value

#73 PR has been merged into main
Screenshot 2023-02-20 at 16 46 31

  • check_as_cran should not write in the user's home filespace

#74

image
image

  • \dontrun{} are replaced by \donttest{}

  • There is no remaining "data/iris.rda" at the root of the dev package (added during unit tests)
    image
    image

Context

  • 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:
    pipe.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. Does not seem necessary.
    Please replace \dontrun with \donttest.

Please unwrap the examples if they are executable in < 5 sec, or replace
dontrun{} with \donttest{}.

  • Please ensure that your functions do not write by default or in your
    examples/vignettes/tests in the user's home filespace (including the
    package directory and getwd()). This is not allowed by CRAN policies.
    Please omit any default path in writing functions. In your
    examples/vignettes/tests you can write to tempdir(). -> R/check_as_cran.R

Metadata

Metadata

Assignees

Type

No type

Projects

Status

👀 In review

Relationships

None yet

Development

No branches or pull requests

Issue actions