cran-comments.md

In dmi3kno/polite: Be Nice on the Web

Third submission

• This is an update for an existing CRAN package.
• No errors were found, when checking on R-hub, except for missing tidy HTML package on Linux. It appears that tidy HTML library is not installed in Rhub infrastructure.

Test environments

• R-hub windows-x86_64-devel (r-devel)
• R-hub ubuntu-gcc-release (r-release)
• R-hub fedora-clang-devel (r-devel)

R CMD check results

0 errors | 0 warnings | 1 note

On Ubuntu Linux 20.04 1 LTS, R-release, GCC and On Fedora Linux, R-devel, clang, gfortran

• checking HTML version of manual ... NOTE Skipping checking HTML validation: no command 'tidy' found

Second submission

• This is an update for an existing CRAN package.

Test environments

• R-hub windows-x86_64-devel (r-devel)
• R-hub ubuntu-gcc-release (r-release)
• R-hub fedora-clang-devel (r-devel)

R CMD check results

0 errors | 0 warnings | 0 notes

revdepcheck results

We checked 2 reverse dependencies (1 from CRAN + 1 from Bioconductor), comparing R CMD check results across CRAN and dev versions of this package.

• We saw 0 new problems
• We failed to check 0 packages

Resubmission 2

CRAN team - This is a second resubmission of a new package responding to feedback from Martina Schmirl on Resubmission 1 below.

> \dontrun{} should be only 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 with \donttest or explain.

Agreed. Provided more realistic examples and replaced \dontrun{} with \donttest{}

Thank you for reviewing my submission! Regards, Dmytro

Resubmission 1

CRAN team - This is a first resubmission of a new package, responding to feedback from Martina Schmirl on intial submission below.

> 1. 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() if you

> really have to write text to the console.

Removed all mentions of cat()/print() in the package, other than in print method of the polite class. Simplified print method by removing dependency on crayon.

> 2. When creating the examples please keep in mind that the structure

> would be desirable:

> \examples{

> examples for users and checks:

> executable in < 5 sec

> \dontshow{

> examples for checks:

> executable in < 5 sec together with the examples above

> not shown to users

> }

> \donttest{

> further examples for users; not used for checks

> (f.i. data loading examples )

> }

> \dontrun{

> not used by checks, not used by example()

> adds the comment ("# Not run:") as a warning for the user.

> }

> if(interactive()){

> functions not intended for use in scripts,

> or are supposed to only run interactively

> (f.i. shiny)

> }

> }

Removed redundant \dontrun statements in scrape() function and controlled that all documentation section use consistent formatting for examples.

> 3. 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()). That is not allow by CRAN policies.

> Please only write/save files if the user has specified a directory in

> the function themselves. In your examples/vignettes/tests you can write to tempdir().

Corrected rip() to write into tempdir() instead of local directory.

Thank you for reviewing my submission! Regards, Dmytro

Initial submission notes

Test environments

• R-hub windows-x86_64-devel (r-devel)
• R-hub ubuntu-gcc-release (r-release)
• R-hub fedora-clang-devel (r-devel)

R CMD check results

0 errors | 0 warnings | 1 note

• This is a new submission.

dmi3kno/polite documentation built on Sept. 9, 2023, 10:51 p.m.