description: Extract the contents of the attribute 'description'

Description Usage Arguments Value Examples

View source: R/description.R

Description

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.

Usage

1
2
3
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

1
2
3
4
5
6
7
8
#Extract the description of the checkFunction identifyMissing
description(identifyMissing)

#Extract the description of the summaryFunction minMax
description(minMax)

#Extract the description of the visualFunction basicVisual
description(basicVisual)

dataMaid documentation built on Dec. 11, 2019, 1:08 a.m.