If the object, x, is itself of class checkFunction, summaryFunction or visualFunction, the contents of x's attribute description is returned. Otherwise, NULL is returned.

description(x)

description(x) <- value

Arguments

x

The object for which the description attribute should be extracted.

value

New value

Value

A description of what x does, given as a character string.

Examples

#Extract the description of the checkFunction identifyMissing description(identifyMissing)
#> [1] "Identify miscoded missing values"
#Extract the description of the summaryFunction minMax description(minMax)
#> [1] "Find minimum and maximum values"
#Extract the description of the visualFunction basicVisual description(basicVisual)
#> [1] "Histograms and barplots using graphics"