The R Project SVN R

Rev

Rev 61160 | Rev 66951 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 61160 Rev 62809
Line 14... Line 14...
14
\usage{
14
\usage{
15
example(topic, package = NULL, lib.loc = NULL,
15
example(topic, package = NULL, lib.loc = NULL,
16
        character.only = FALSE, give.lines = FALSE, local = FALSE,
16
        character.only = FALSE, give.lines = FALSE, local = FALSE,
17
        echo = TRUE, verbose = getOption("verbose"),
17
        echo = TRUE, verbose = getOption("verbose"),
18
        setRNG = FALSE, ask = getOption("example.ask"),
18
        setRNG = FALSE, ask = getOption("example.ask"),
19
        prompt.prefix = abbreviate(topic, 6))
19
        prompt.prefix = abbreviate(topic, 6),
-
 
20
        run.dontrun = FALSE)
20
}
21
}
21
\arguments{
22
\arguments{
22
  \item{topic}{name or literal character string: the online
23
  \item{topic}{name or literal character string: the online
23
    \code{\link{help}} topic the examples of which should be run.}
24
    \code{\link{help}} topic the examples of which should be run.}
24
  \item{package}{a character vector giving the package names to look
25
  \item{package}{a character vector giving the package names to look
Line 51... Line 52...
51
    \code{echo == TRUE} and the graphics device appears to be
52
    \code{echo == TRUE} and the graphics device appears to be
52
    interactive.  This parameter applies both to any currently opened
53
    interactive.  This parameter applies both to any currently opened
53
    device and to any devices opened by the example code.}
54
    device and to any devices opened by the example code.}
54
  \item{prompt.prefix}{character; prefixes the prompt to be used if
55
  \item{prompt.prefix}{character; prefixes the prompt to be used if
55
    \code{echo = TRUE}.}
56
    \code{echo = TRUE}.}
-
 
57
  \item{run.dontrun}{logical indicating that \verb{\dontrun}
-
 
58
    should be ignored.}
56
}
59
}
57
\value{
60
\value{
58
  The value of the last evaluated expression, unless \code{give.lines}
61
  The value of the last evaluated expression, unless \code{give.lines}
59
  is true, where a \code{\link{character}} vector is returned.
62
  is true, where a \code{\link{character}} vector is returned.
60
}
63
}