Skip to contents

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

Usage

description(x)

description(x, overwrite = FALSE) <- value

Arguments

x

A dataset object created with dataset::dataset.

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 FALSE, when it gives a warning at an accidental overwrite attempt.

value

The Description as a character set.

Value

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

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.

See also

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

Examples

description(iris_dataset, overwrite = TRUE) <- "The famous iris dataset used
in R language examples."
description(iris_dataset)
#> [1] "The famous iris dataset used\nin R language examples."