dev_example

0th

Percentile

Run a examples for an in-development function.

dev_example is a replacement for example. run_example is a low-level function that takes a path to an Rd file.

Usage
dev_example(topic, quiet = FALSE)

run_example(path, test = FALSE, run = FALSE, env = new.env(parent = globalenv()), quiet = FALSE)

Arguments
topic

Name or topic (or name of Rd) file to run examples for

quiet

If TRUE, does not echo code to console.

path

Path to .Rd file

test

if TRUE, code in \donttest{} will be commented out. If FALSE, code in \testonly{} will be commented out. This parameter is only used in R 3.2 and greater.

run

if TRUE, code in \dontrun{} will be commented out.

env

Environment in which code will be run.

Aliases
  • dev_example
  • run_example
Examples
# NOT RUN {
# Runs installed example:
library("ggplot2")
example("ggplot")

# Runs develoment example:
dev_example("ggplot")
# }
Documentation reproduced from package pkgload, version 1.0.2, License: GPL-3

Community examples

Looks like there are no examples yet.