description {tis}R Documentation

Description and Documentation Attributes

Description

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

Usage

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.


[Package tis version 1.39 Index]