Fix deprecated roxygen2 pkg-level documentation in pkg and template #103
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DataPackageR
currently uses package-level documentation syntax that has been deprecated inroxygen2
since ~2019. It uses this both for its own package-level documentation and in its template for creating new data package skeletons.With recent versions of
roxygen2
, e.g.7.3.1
, the warning surfaces both during routine building of data packages and during R CMD check.517198f fixes the data package skeleton template. Keeping the
@name
tag is not required byroxygen2
but is necessary for fragile-looking downstream scraping functionality inDataPackageR
to still work without modifications.95957a0 fixes
DataPackageR
's own documentation. The new method auto-generates some additional author info etc. for the package-level.Rd
file.One broken unit test needed to be updated to be be more robust.
I installed this branch locally and did a test build of
Schief546
to verify that the build still works and the warning no longer appears. With this PR, the package also passesdevtools::check()
cleanly on my local machine.This is probably not directly relevant to DPR2, since @jmtaylor-fhcrc et al. have presumably been using newer
roxygen2
versions.