Skip to content

Update package help documentation #105

@leppott

Description

@leppott

See penultimate section header on this blog for more info on the issue from CRAN.

https://www.r-bloggers.com/2023/08/ropensci-news-digest-august-2023/

In BioMonTools.R file change

from

#' @docType package
#' @name BioMonTools

to

"_PACKAGE"`

From another package:

Dear maintainer,

You have file 'baytrends/man/baytrends.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
r-lib/roxygen2#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 baytrends-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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions