examples_to_yaml

Convert examples for a specified package, optionally restricted to one or more specified functions, to a list of 'autotest' 'yaml' objects to use to automatically test package.

Usage

examples_to_yaml(
  package = NULL,
  functions = NULL,
  exclude = NULL,
  quiet = FALSE
)

Arguments

package

Name of package, as either

1. Path to local package source

2. Name of installed package

3. Full path to location of installed package if not on .libPaths, or

4. Default which presumes current directory is within package to be tested.

functions

If specified, names of functions from which examples are to be obtained.

exclude

Names of functions to exclude from 'yaml' template

quiet

If 'FALSE', provide printed output on screen.

See also

Other yaml: at_yaml_template(), autotest_yaml()