example.sources: Specify sources files or texts from which examples shall be...

Description Usage Arguments

View source: R/parse_examples.r

Description

There are different sources that differ how examples are written in the file

Usage

1
2
example.sources(ex.in.fun.files = NULL, ex.files = NULL, rmd.files = NULL,
  ex.in.fun.text = NULL, ex.text = NULL)

Arguments

ex.in.fun.files

Files that contain one or several examples within functions that have no argument. E.g. a function named my.example() whose body contains the examples.

ex.files

Files whose code directly specifies an examples, i.e. examples are not within functions.

rmd.files

Rmd files whose chunks specify examples. Chunks will be evaluated sequentially step by step. Chunks with include=FALSE or eval=FALSE will be ignored.

ex.in.fun.text

Similar to ex.in.fun.files but code will be provided as string.

ex.text

Similar to ex.files but code will be provided as string.


skranz/testexamples documentation built on Nov. 28, 2019, 12:12 a.m.