Update documentation per

[leppott]

Describe the bug Received message as maintainer of the package about a change in documentation standards.

Non-urgent but need to submit fix in the "next few months".

To Reproduce Email on 2023-08-19

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

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Additional context Add any other context about the problem here.

[leppott]

Non-urgent. Try to wait until ready for other package updates (Jan 2024).

[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/

[leppott]

In baytrends.R file change

from

#' @docType package
#' @name baytrends

to

"_PACKAGE"`