stamp | R Documentation |
A line is added to the current plot in the lower right corner that contains project information and date.
stamp(sure = TRUE, outer.margin = NULL,
project = getOption("project"), step = getOption("step"),
stamp = NULL, line = NULL, ploptions = NULL, ...)
sure |
if FALSE, the stamp will only be added if
|
outer.margin |
if TRUE, the stamp is put to the outer margin of the plot. This is the default if the plot is currently split into panels. |
project, step |
character string describing the project and the step of analysis. |
stamp |
controls default action, see details |
line |
line in the (outer) margin on which the stamp should be shown. |
ploptions |
pl options |
... |
arguments passed to |
The function is used to document plots produced during a data
analysis. It is called by all plotting functions of this package.
For getting final presentation versions of the plots, the stamp can be
suppressed by changing the default by calling options(stamp=0)
.
In more detail: If stamp==0
(or options("stamp")==0
)
the function will only do its thing if sure==TRUE
.
If stamp==2
, it will certainly do it.
If stamp==1
and sure==FALSE
, the stamp is added when a
plot page is complete.
invisibly returns the string that is added to the plot – consisting of project title, step title and current date (including time).
Werner A. Stahel, ETH Zurich
options(project="Example A", step="regression analysis")
plot(1:10)
stamp() ##-> "stamp" at bottom of right border
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.