description {dataset} | R Documentation |
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 = FALSE) <- value
Arguments
x |
A dataset object created with |
overwrite |
If the |
value |
The |
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:
geolocation()
,
identifier()
,
language
,
publication_year()
,
publisher()
,
rights()
Examples
description(orange_df)
description(
orange_df,
overwrite = TRUE
) <- "The 'orange' dataset has 35 rows and 3 columns
of records of the growth of orange trees."
description(orange_df)