Get or set the dataset Description

Get or set the optional Description property as an attribute on a dataset object.

Usage

description(x)

description(x, overwrite = FALSE) <- value

Arguments

x

A dataset object created with dataset_df() or as_dataset_df().

overwrite

Logical. If TRUE, will overwrite any existing description. If FALSE (default), will warn and keep the existing description.

value

The new description, as a character string.

Value

The Description attribute as a character vector of length 1.

Details

The Description is recommended for discovery in DataCite. It captures additional information that does not fit other metadata categories — such as technical notes or dataset usage. It is a free-text field. See dct:description.

See also

Other bibliographic helper functions: contributor(), creator(), dataset_format(), dataset_title(), geolocation(), get_bibentry(), language, publication_year(), publisher(), relation(), rights(), subject()

Examples

description(orange_df)
#> [1] "The Orange data frame has 35 rows and 3 columns of records of the growth of orange trees."
description(orange_df, overwrite = TRUE) <- "This dataset records orange tree growth."
description(orange_df)
#> [1] "This dataset records orange tree growth."