description: Description and Documentation Attributes

Description Usage Arguments Value

View source: R/description.R

Description

Get or set the description and documentation strings for an object.

Usage

1
2
3
4
description(x)
description(x) <- value
documentation(x)
documentation(x) <- value

Arguments

x

object whose description or documentation attribute is to be set or retrieved

value

a string

Value

The setters invisibly return x, the getters return the desired attribute or NULL.


tis documentation built on Sept. 29, 2021, 1:06 a.m.