Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 3.42 KB

cran-comments.md

File metadata and controls

74 lines (46 loc) · 3.42 KB

Update v1.0.2

Test environments

  • Mac OS X 10.15.7, R-devel
  • Ubuntu 20.04.3 LTS, R-devel

R CMD check results

0 errors | 0 warnings | 0 notes

Reverse dependencies

None

Original release

Third submission

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 always add all authors, contributors and copyright holders in the Authors@R field with the appropriate roles. From CRAN policies you agreed to: "... Where copyrights are held by an entity other than the package authors, this should preferably be indicated via ‘cph’ roles in the ‘Authors@R’ field, or using a ‘Copyright’ field (if necessary referring to an inst/COPYRIGHTS file)." e.g.: Peak AI

Have added an entry in the Authors@R field of the DESCRIPTIONS file referencing PEAK AI LIMITED as the copyright holder. Have also created an inst/COPYRIGHTS file with details of the copyright. The COPYRIGHTS file is also being referenced in the Copyright field of the the DESCRIPTIONS file.

Second submission

Please add some more details about the package functionality and implemented methods in your Description text.

The Description text has been updated with more detail.

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:......

There are no references to include here. The methods applied are all built in-house.

Please write TRUE and FALSE instead of T and F. (Please don't use 'T' or 'F' as vector names.)

All uses of T and F have been changed to TRUE or FALSE.

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.

This has now been added to all exported functions.

You write information messages to the console that cannot be easily suppressed. It is more R like to generate objects that can be used to extract the information a user is interested in, and then print() that object. Instead of print()/cat() rather use message()/warning() or if(verbose)cat(..) (or maybe stop()) if you really have to write text to the console. (except for print, summary, interactive functions)

print() statements have all been replaced by appropriate applications of warning() or message(). All messages are also put behind if(verbose) conditions.

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. In your examples/vignettes/tests you can write to tempdir().

Oversight on our side. We believe it was caused by a saveouput = TRUE argument in one of our unit tests. This has been set to FALSE now.

Test environments

  • Mac OS X 10.15.7, R-devel
  • Ubuntu 20.04.3 LTS, R-devel

R CMD check results

0 errors | 0 warnings | 1 notes

New submission

Reverse dependencies

None