Skip to contents

Get or reset the dataset's main title.

Usage

dataset_title(x)

dataset_title(x, overwrite = FALSE) <- value

Arguments

x

A dataset object created with dataset() or as_dataset().

overwrite

If the attributes should be overwritten. In case it is set to FALSE,it gives a warning with the current title property instead of overwriting it. Defaults to FALSE.

value

The name(s) or title(s) by which a resource is known. See: dct:title.

Value

A string with the dataset's title; set_dataset_title returns a dataset object with the changed (main) title.

Details

In the DataCite definition, several titles can be used; it is not yet implemented.

Examples

dataset_title(iris_dataset)
#> [1] "Iris Dataset"
dataset_title(iris_dataset, overwrite = TRUE) <-"The Famous Iris Dataset"
dataset_title(iris_dataset)
#> [1] "The Famous Iris Dataset"