run_nopurl_rmd: Run *.nopurl.Rmd files

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

Run ⁠*.nopurl.Rmd⁠ files

Description

Executes .Rmd files which are supposed to contain code not included in the source package, i.e. usually outsourced to separate .Rmd files with the .nopurl suffix in their filenames. Those files are typically used to generate package data.

If an error is encountered saying ⁠internal error -3 in R_decompress1⁠, restart the R session and run again.

Usage

run_nopurl_rmd(
  path = ".",
  path_rmd = fs::dir_ls(path = fs::path(path, "Rmd"), recurse = TRUE, type = "file", glob
    = "*.nopurl.Rmd"),
  env = NULL,
  document = TRUE,
  build_and_install = TRUE,
  restart_r_session = TRUE,
  quiet = TRUE,
  roclets = NULL,
  args = getOption("devtools.install.args"),
  dependencies = NA,
  upgrade = "never",
  keep_source = getOption("keep.source.pkgs")
)

Arguments

path	Path to the root of the package directory.
path_rmd	Path(s) to the .Rmd files to be executed. A character vector.
env	Environment to evaluate the .Rmd files in. If NULL, the global environment is used.
document	Whether or not to re-build the package documentation after the last .Rmd file is executed.
build_and_install	Whether or not to build and install the package after each .Rmd file execution.
restart_r_session	Whether or not to restart the R session after the last .Rmd file is executed. Highly recommended if build_and_install = TRUE, but only possible when R is run within RStudio.
quiet	if TRUE suppresses output from this function.
roclets	Character vector of roclet names to use with package. The default, NULL, uses the roxygen roclets option, which defaults to c("collate", "namespace", "rd").
args	An optional character vector of additional command line arguments to be passed to ⁠R CMD INSTALL⁠. This defaults to the value of the option "devtools.install.args".
dependencies	Which dependencies do you want to check? Can be a character vector (selecting from "Depends", "Imports", "LinkingTo", "Suggests", or "Enhances"), or a logical vector. TRUE is shorthand for "Depends", "Imports", "LinkingTo" and "Suggests". NA is shorthand for "Depends", "Imports" and "LinkingTo" and is the default. FALSE is shorthand for no dependencies (i.e. just check this package, not its dependencies). The value "soft" means the same as TRUE, "hard" means the same as NA. You can also specify dependencies from one or more additional fields, common ones include: Config/Needs/website - for dependencies used in building the pkgdown site. Config/Needs/coverage for dependencies used in calculating test coverage.
upgrade	Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default" respects the value of the R_REMOTES_UPGRADE environment variable if set, and falls back to "ask" if unset. "ask" prompts the user for which out of date packages to upgrade. For non-interactive sessions "ask" is equivalent to "always". TRUE and FALSE are also accepted and correspond to "always" and "never" respectively.
keep_source	If TRUE will keep the srcrefs from an installed package. This is useful for debugging (especially inside of RStudio). It defaults to the option "keep.source.pkgs".

Value

path_rmd, invisibly.

See Also

Other high-level functions: lint_rmd(), load_pkg(), process_pkg(), purl_rmd()

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