ggPMXdevelopment / ggPMX

ggPMX R package
37 stars 13 forks source link

CRAN package requirement. #373

Closed mattfidler closed 1 year ago

mattfidler commented 1 year ago

Dear maintainer,

You have file 'ggPMX/man/ggPMX.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://urldefense.com/v3/https://github.com/r-lib/roxygen2/issues/1491;!!N3hqHg43uw!rd-7cyXKAJQKr_8S7Vatc9Fr-2lh1kwOFnmemSkIRzB0Fk4PAtq6WAQkJrh1Q4hfq1bLFxjHev2WQUZc356qIGDHSw$ >.

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