Skip to content

Commit

Permalink
Update Roxygen version
Browse files Browse the repository at this point in the history
I also followed the advice to remove the deprecated tag `@docType package` and instead document the special object `"_PAKCAGE"`. I used `usethis::use_package_doc()` for this and then moved the `@importFrom`s.

The change for users here is that the top-level documentation available to users in R should be easier to get to (more aliases) and will have better content (since it will now auto-populate from the DESCRIPTION file.
  • Loading branch information
Moohan committed Jul 1, 2024
1 parent d737fcb commit b1cc28e
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 34 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ Encoding: UTF-8
Language: en-GB
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
VignetteBuilder: knitr
11 changes: 11 additions & 0 deletions R/phsmethods-package.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#' @importFrom magrittr %>%
#' @importFrom magrittr %<>%
#' @importFrom rlang .data
#' @importFrom tibble tibble
#' @importFrom lifecycle deprecated
#' @keywords internal
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL
20 changes: 0 additions & 20 deletions R/phsmethods.R

This file was deleted.

44 changes: 44 additions & 0 deletions man/phsmethods-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 0 additions & 13 deletions man/phsmethods.Rd

This file was deleted.

0 comments on commit b1cc28e

Please sign in to comment.