In salim-b/pkgpurl: Facilitate Authoring R Packages in the R Markdown File Format

NOTES

• This file is not included in the source package because of the .nopurl suffix in its filename.

• The chunks below have to be manually executed in order to regenerate the package data.

• Although the datasets below are saved as "internal data" in R/sysdata.rda, they can still be exported and documented (by documenting the dataset's quoted name in the main .Rmd source file – which only works when the dataset is also @exported), something not explicitly mentioned in the book R Packages. To do so, you first need to manually add the export() directive in the NAMESPACE file since roxygen2 won't add it automatically.

Define data

funky_config

funky_config <-
  funky::ptype_config |>
  tibble::add_row(key = "some_required_key",
                  default_value = list("some value")
                  require = TRUE,
                  description = "what is some required key for?") |>
  tibble::add_row(key = "some_optional_key",
                  require = FALSE,
                  description = "what is some optional key for?")

Write data

Save all the small data objects as a single internal file R/sysdata.rda. Note that when documenting them, they must be explicitly @exported to be available to package users.

usethis::use_data(funky_config,
                  internal = TRUE,
                  overwrite = TRUE,
                  compress = "xz",
                  version = 3L)

salim-b/pkgpurl documentation built on June 2, 2025, 8:26 a.m.