Skip to content

Commit

Permalink
update cran-comments before the new release
Browse files Browse the repository at this point in the history
  • Loading branch information
boennecd committed Sep 7, 2021
1 parent b408e83 commit 4206fb8
Showing 1 changed file with 16 additions and 118 deletions.
134 changes: 16 additions & 118 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,127 +1,25 @@
## Test environments
* Ubuntu 18.04 LTS with gcc 10.1.0
R version 3.6.3
* Ubuntu 18.04 LTS with clang-6.0.0
R devel 2021-02-03 r79933 with ASAN and UBSAN
* Ubuntu 16.04 LTS (on travis-ci)
R version 4.0.0
* win-builder (devel and release)
* Ubuntu 20.04 LTS with gcc 10.1.0
R version 4.1.1
* Ubuntu 20.04 LTS with gcc 10.1.0
R devel 2021-09-06 r80861 with LTO checks
* Ubuntu 20.04 LTS with gcc 10.1.0
R version 4.1.1 with valgrind
* Ubuntu 20.04 LTS with gcc 10.1.0
R devel 2021-09-05 r80859 with ASAN and UBSAN
* Github actions on windows-latest (release), macOS-latest (release),
ubuntu-20.04 (release), and ubuntu-20.04 (devel)
* win-builder (devel, oldrelease, and release)
* `rhub::check_for_cran()`
* `rhub::check(platform = c("debian-gcc-devel", "debian-clang-devel", "fedora-clang-devel", "fedora-clang-devel"))`
* `rhub::check(platform = c("fedora-clang-devel", "macos-highsierra-release-cran"))`

## R CMD check results
The issue with the test which caused the package to be removed from CRAN has
been fixed.

There were no WARNINGs or ERRORs.

There is a NOTE about the package size in some cases.

## Resubmission
This is a resubmission. I have addressed the issues stated below.

> Please write TRUE and FALSE instead of T and F. (Please don't use 'T' or
> 'F' as vector names.)
T and F is no longer used. Instead TRUE and FALSE is used. Also, T and F
are no longer used for vector names.

> 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:
> ddFixed.Rd: \value
> ddhazard_app.Rd: \value
> logLik.ddhazard.Rd: \value
> plot.ddhazard_space_errors.Rd: \value
> plot.ddhazard.Rd: \value
> predict.ddhazard.Rd: \value
> print.ddhazard_boot.Rd: \value
> residuals.ddhazard.Rd: \value
There is a \value section for all of the above now.

> \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 in every case.
>
> Please unwrap the examples if they are executable in < 5 sec, or replace
> \dontrun{} with \donttest{}.
\donttest is used instead of \dontrun. The exception is `ddhazard_app` where
the example launches a Shiny app. Thus, `R CMD CHECK` runs forever on Github
actions and with rhub if this example is in \donttest.

> You are setting options(warn=-1) in your function. This is not allowed.
> Please rather use suppressWarnings() if really needed.
I removed options(warn=-1).

> Please make sure that you do not change the user's options, par or
> working directory. If you really have to do so within functions, please
> ensure with an *immediate* call of on.exit() that the settings are reset
> when the function is exited. e.g.:
> ...
> oldpar <- par(no.readonly = TRUE) # code line i
> on.exit(par(oldpar)) # code line i + 1
> ...
> par(mfrow=c(2,2)) # somewhere after
> ...
>
> e.g.: inst/doc.. files
Par is always reset now (also in the vignettes).

> Please always make sure to reset to user's options(), working directory
> or par() after you changed it in examples and vignettes and demos.
> e.g.: ddsurvcurve.Rd
> oldpar <- par(mfrow = c(1,2))
> ...
> par(oldpar)
>
> old <- options(digits = 3)
> ...
> options(old)
Options are always reset now.

> Please do not modify the .GlobalEnv. This is not allowed by the CRAN
> policies.
I have discussed this before with a submission of my SimSurvNMarker package to
CRAN . I do like `getS3method("simulate", "lm")` (set the random seed in a
similar way).

Gregor Seyer wrote the following on the 4th of September 2020:

> Thanks for the explanation.
> In this case it should not be a problem.
> Please do not modify the global environment (e.g. by using <<-) in your
> functions. This is not allowed by the CRAN policies.
There are no ways that there will be assignments to the global environment with
<<- as far as I can see except for an assignment of `.Random.seed` in a test
that is not run on CRAN.

> Please ensure that you do not use more than 2 cores in your examples,
> vignettes, etc.
There should not be used more than 2 cores anywhere.

> Additionally:
> Have the issues why your package was archived been fixed?
> Please explain this in the submission comments.
Yes, as I wrote in my last submission:

> The issue with the test which caused the package to be removed from CRAN has
> been fixed.
There is a NOTE about a 404 error for one of the DOIs in the description. This
is for a Journal of Statistical Software paper that will be published soon.
The paper is the reason for this update.

There has been changes in speedglm which seems to have caused a bug with the
weights argument when speedglm::speedglm is called in a function. I found a
workaround and thus submitted a new version of my package.
There is NOTE that Christoffersen is possibly misspelled. It is not.

0 comments on commit 4206fb8

Please sign in to comment.