doc: Define and obtain the doc or tit attribute

Description Usage Arguments Details Value Author(s) Examples

View source: R/regr.R

Description

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.

Usage

1
2
3
4
doc(x)
tit(x) 
doc(x) <- value
tit(x) <- value

Arguments

x

object to which the doc or tit attribute should be attached or from which it is obtained

value

character vector (doc) or string (tit) to be stored

Details

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).

Value

doc and tit return the respective attributes of object x

Author(s)

Werner A. Stahel, ETH Zurich

Examples

1
2
3
4
data(d.blast)
doc(d.blast)
doc(d.blast) <- "I will use this dataset in class soon."
doc(d.blast)

regr0 documentation built on May 31, 2017, 2:26 a.m.

Related to doc in regr0...