description: Get/set the Description of the object.

In dataset: Create Data Frames that are Easier to Exchange and Reuse

Get/set the Description of the object.

Description

Get/set the optional Description property as an attribute to an R object.

Usage

description(x)

description(x, overwrite = TRUE) <- value

Arguments

x	An R object, such as a data.frame, a tibble, or a data.table.
overwrite	If the Description attribute should be overwritten. In case it is set to FALSE, it gives a message with the current Description property instead of overwriting it. Defaults to TRUE when the attribute is set to value regardless of previous setting.
value	The Description as a character set.

Details

The Description is recommended for discovery in DataCite. All additional information that does not fit in any of the other categories. May be used for technical information. A free text. Similar to dct:description.

Value

The Description attribute as a character of length 1 is added to x.

See Also

Other Reference metadata functions: creator(), dataset_source(), geolocation(), identifier(), language, publication_year(), publisher(), rights(), size(), version()

Examples

iris_dataset <- iris
description(iris_dataset) <- "The famous iris dataset used in R language examples."
description(iris_dataset)

dataset documentation built on March 31, 2023, 10:24 p.m.