search

florianhartig / BayesianTools

General-Purpose MCMC and SMC Samplers and Tools for Bayesian Statistics
https://cran.r-project.org/web/packages/BayesianTools/index.html
115 stars 29 forks source link

CRAN DHARMa.Rd issue #251

Closed florianhartig closed 8 months ago

florianhartig commented 10 months ago

Dear maintainer,

You have file 'BayesianTools/man/BayesianTools.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 BayesianTools-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

florianhartig commented 9 months ago

https://r-pkgs.org/man.html#sec-man-package-doc

TahminaMojumder commented 8 months ago

' @keywords internal

"_PACKAGE"

creates automatic documentation from description - this is not what we want - is there a way to have the automatic description with add-ons to add the text in the old package help?

Easiest seems to add the @Aliases BayesianTools-package

TahminaMojumder commented 8 months ago

Note it only works if you use @aliases, not@Aliases.