| Line 1... |
Line 1... |
| 1 |
% File src/library/utils/man/example.Rd
|
1 |
% File src/library/utils/man/example.Rd
|
| 2 |
% Part of the R package, https://www.R-project.org
|
2 |
% Part of the R package, https://www.R-project.org
|
| 3 |
% Copyright 1995-2024 R Core Team
|
3 |
% Copyright 1995-2026 R Core Team
|
| 4 |
% Distributed under GPL 2 or later
|
4 |
% Distributed under GPL 2 or later
|
| 5 |
|
5 |
|
| 6 |
\name{example}
|
6 |
\name{example}
|
| 7 |
\alias{example}
|
7 |
\alias{example}
|
| 8 |
\title{Run an Examples Section from the Online Help}
|
8 |
\title{Run an Examples Section from the Online Help}
|
| Line 49... |
Line 49... |
| 49 |
number generator state is saved, then initialized to a specified state,
|
49 |
number generator state is saved, then initialized to a specified state,
|
| 50 |
the example is run and the (saved) state is restored.
|
50 |
the example is run and the (saved) state is restored.
|
| 51 |
\code{setRNG = TRUE} sets the same state as
|
51 |
\code{setRNG = TRUE} sets the same state as
|
| 52 |
\command{R CMD \link{check}} does for
|
52 |
\command{R CMD \link{check}} does for
|
| 53 |
running a package's examples. This is currently equivalent to
|
53 |
running a package's examples. This is currently equivalent to
|
| 54 |
\code{setRNG = \{RNGkind("default", "default", "default"); set.seed(1)\}}.}
|
54 |
\code{setRNG = \{RNGkind("default", "default", "default", "default"); set.seed(1)\}}.}
|
| 55 |
\item{ask}{logical (or \code{"default"}) indicating if
|
55 |
\item{ask}{logical (or \code{"default"}) indicating if
|
| 56 |
\code{\link{devAskNewPage}(ask = TRUE)} should be called
|
56 |
\code{\link{devAskNewPage}(ask = TRUE)} should be called
|
| 57 |
before graphical output happens from the example code. The value
|
57 |
before graphical output happens from the example code. The value
|
| 58 |
\code{"default"} (the factory-fresh default) means to ask if
|
58 |
\code{"default"} (the factory-fresh default) means to ask if
|
| 59 |
\code{echo} is true and the graphics device appears to be
|
59 |
\code{echo} is true and the graphics device appears to be
|