search

ixpantia / ixplorer

Friendly DataOps with RStudio
https://ixpantia.github.io/ixplorer/
Other
2 stars 11 forks source link

document _PACKAGE to get all the defaults for package documentation #155

Closed FvD closed 1 year ago

FvD commented 1 year ago

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

FvD commented 1 year ago

Solved using the following (second line to replace the @importFrom in the ixplorer.R file. 

usethis::use_package_doc()
usethis::use_import_from("dplyr", "%>%")

I deleted the ixplorer.R file (I did not see that mentioned in the documentation, but it makes no sense to leave the "old approach there". To delete I moved the utils::globalVariables() line to ixplorer-package.R.