admiraldev (version 1.3.1)

execute_example: Execute Example Code

Description

This function executes the example code and captures the output and messages. If the example code issues an unexpected message, an error is issued.

Usage

execute_example(code, expected_cnds = NULL, env = caller_env())

Value

A character vector of the input code and the output and messages created by the code. Output and messages are prefixed by "#>".

Arguments

code

The example code

The code is expected to be a character vector of R code lines.

Permitted values

A character vector

Default value

none

expected_cnds

Expected conditions

Permitted values

A character vector

Default value

NULL

env

The environment in which to evaluate the example code

Permitted values

An environment

Default value

caller_env()

Examples

Execute Example Code

admiraldev:::execute_example("1 + 1")
#> [1] "1 + 1\n#> [1] 2"
admiraldev:::execute_example("log(-1)")
#> Error in capture_output(!!expr$expr, srcref = srcref, expected_cnds = expected_cnds,  : 
#>   The expression
#> > log(-1)
#> issued an unexpected condition:
#> NaNs produced
#> If this is expected, add any of the classes "simpleWarning", "warning", and
#> "condition" to the argument `expected_cnds`.
admiraldev:::execute_example("log(-1)", expected_cnds = "warning")
#> [1] "log(-1)\n#> [1] NaN\n#> Warning in log(-1) : NaNs produced"