devtools: run_examples – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

run_examples

Run all examples in a package.

Description

One of the most frustrating parts of R CMD check is getting all of your examples to pass - whenever one fails you need to fix the problem and then restart the whole process. This function makes it a little easier by making it possible to run all examples from an R function.

Usage

run_examples(
  pkg = ".",
  start = NULL,
  show = TRUE,
  run_donttest = FALSE,
  run_dontrun = FALSE,
  fresh = FALSE,
  document = TRUE,
  run,
  test
)

Arguments

`pkg`	The package to use, can be a file path to the package or a package object. See `as.package()` for more information.
`start`	Where to start running the examples: this can either be the name of `Rd` file to start with (with or without extensions), or a topic name. If omitted, will start with the (lexicographically) first file. This is useful if you have a lot of examples and don't want to rerun them every time you fix a problem.
`show`	DEPRECATED.
`run_donttest`	if `TRUE`, do run `\donttest` sections in the Rd files. out.
`run_dontrun`	if `TRUE`, do run `\dontrun` sections in the Rd files.
`fresh`	if `TRUE`, will be run in a fresh R session. This has the advantage that there's no way the examples can depend on anything in the current session, but interactive code (like `browser()`) won't work.
`document`	if `TRUE`, `document()` will be run to ensure examples are updated before running them.
`run`	Deprecated, see `run_dontrun` and `run_donttest` above.
`test`	Deprecated, see `run_dontrun` and `run_donttest` above.

devtools

Tools to Make Developing R Packages Easier

v2.4.1

MIT + file LICENSE

Authors

Hadley Wickham [aut], Jim Hester [aut, cre], Winston Chang [aut], RStudio [cph, fnd]

Initial release

run_examples

Description

Usage

Arguments

devtools

We don't support your browser anymore