search

zachmayer / caretEnsemble

caret models all the way down :turtle:
Other
226 stars 75 forks source link

Fix CRAN docs #259

Closed zachmayer closed 9 months ago

zachmayer commented 9 months ago

Fix package documentation and update deprecated linters.

Email from Kurt.Hornik@r-project.org:


You have file 'caretEnsemble/man/caretEnsemble.Rd' with
\docType{package}, likely intended as a package overview help file, but
without the appropriate PKGNAME-package \alias as per "Documenting
packages" in R-exts.

This seems to be the consequence of the breaking change

  Using @docType package no longer automatically adds a -package alias.
  Instead document _PACKAGE to get all the defaults for package
  documentation.

in roxygen2 7.0.0 (2019-11-12) having gone unnoticed, see
<https://github.com/r-lib/roxygen2/issues/1491>.

As explained in the issue, to get the desired PKGNAME-package \alias
back, you should either change to the new approach and document the new
special sentinel

  "_PACKAGE"

or manually add

  @aliases caretEnsemble-package

if remaining with the old approach.

Please fix in your master sources as appropriate, and submit a fixed
version of your package within the next few months.

Best,
-k
zachmayer commented 9 months ago

New package is live on CRAN: https://cran.r-project.org/web/packages/caretEnsemble/index.html