R: Run an Examples section from the online help

example {base}

R Documentation

Run an Examples section from the online help

Description

Run all the R code from the EXAMPLES part of R's online help topic topic.

Usage

example(topic, package= .packages(), lib=.lib.loc,
        echo=TRUE, verbose=.Options$verbose,
        prompt.echo = paste(abbreviate(topic, 6),"> ", sep=""),
        directory.sep= "/")

Arguments

topic

name or character: The online help topic the examples of which should be run.

package

a character vector with package names.

lib

a character vector with path names of R package libraries.

echo

logical; if TRUE, show the R input when sourcing.

verbose

logical; if TRUE, show even more when running example code.

prompt.echo

character; gives the prompt to be used if echo = TRUE.

directory.sep

character; the directory separating character (an idea to make this OS independent).

Value

(the value of the last evaluated expression).

Note

The examples can be many small files. On some file systems it is desirable to save space, and the files in the ‘R-ex’ directory of an installed package can be zipped up as a zip archive ‘Rex.zip’.

Author(s)

Martin Maechler

Examples

example("smooth", package="eda")
example(dbinom)

[Package base version 0.90 ]