dataset_title: Get/set title(s) of a dataset

View source: R/dataset_title.R

dataset_titleR Documentation

Get/set title(s) of a dataset

Description

Add one or more Title(s) to the dataset's metadata.

Usage

dataset_title(x)

dataset_title(x, overwrite = FALSE) <- value

dataset_title_create(Title, titleType = "Title")

Arguments

x

An R object

overwrite

Defaults to FALSE.

value

The name(s) or title(s) by which a resource is known. A character string or a Title object created by dataset_title_create.Similar to dct:title.

Title

The name(s) or title(s) by which a resource is known, including Title, AlternativeTitle, Subtitle, TranslatedTitle, OtherTitle. May be the title of a dataset or the name of a piece of software. Similar to dct:title.
Use dataset_title_create to create a several title entries.

titleType

In DataCite, the controlled values are AlternativeTitle, Subtitle, TranslatedTitle, Other. When no titleType is given (as in Dublin Core), the titleType is set to Title.

Details

In the DataCite definition, several titles can be used.

Value

The titles as a data.frame with a titleTypes column.

Examples

my_iris <- iris

dataset_title(my_iris) <- dataset_title_create(
    Title = c("Iris Dataset",
    "The famous iris dataset of the R examples"),
    titleType = c("Title", "Subtitle")
    )
dataset_title(my_iris)

 y <- data.frame()
 dataset_title(y) <- "R (Computer program language)"
 dataset_title(y) <- "Questionnaires--Computer programs"
 dataset_title(y)

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