doc {regr0} | R Documentation |
The attributes doc
and tit
describe an object, typically
a data frame or a model. tit
should be a short description (title),
doc
should contain all documentation useful to identify
the origin and the changes made to the object.
The doc
and tit
functions set them and extract these
attributes.
doc(x) tit(x) doc(x) <- value tit(x) <- value
x |
object to which the |
value |
character vector ( |
Plotting and printing functions may search for the tit
attribute or even for the doc
attribute, depending on
c.env$docout
.
doc(x) <- text
will append the existing doc(x)
text to
the new one unless the first element of text equals "^"
,
whereas tit(x) <- string
replaces tit(x)
.
doc
and tit
return the respective attributes of object
x
Werner A. Stahel, ETH Zurich
data(d.blast) doc(d.blast) doc(d.blast) <- "I will use this dataset in class soon." doc(d.blast)