dublincore: Add DublinCore metadata to an object

Description

Add metadata conforming the DataCite Metadata Schema to datasets, i.e. structured R data.frame or list objects, for an accurate and consistent identification of a resource for citation and retrieval purposes.

Usage

dublincore(x)
dublincore_add(
  x,
  Title = NULL,
  Creator = NULL,
  Identifier = NULL,
  Publisher = NULL,
  Subject = NULL,
  Date = NULL,
  Source = NULL,
  Language = NULL,
  Format = NULL,
  Rights = NULL,
  Relation = NULL,
  Description = NULL,
  Type = "DCMITYPE:Dataset",
  overwrite = TRUE
)

Value

The Dublin Core Metadata elements of the dataset.

Arguments

x: An R object of type data.frame, or inherited data.table, tibble; alternatively a well structured R list.
Title: dct:title, a name given to the resource. datacite allows the use of alternate titles, too. See dataset_title.
Creator: An entity primarily responsible for making the resource. dct:creator Corresponds to Creator in datacite. See creator.
Identifier: An unambiguous reference to the resource within a given context. Recommended practice is to identify the resource by means of a string conforming to an identification system. Examples include International Standard Book Number (ISBN), Digital Object Identifier (DOI), and Uniform Resource Name (URN). Select and identifier scheme from registered URI schemes maintained by IANA. More details: Guidelines for using resource identifiers in Dublin Core metadata and IEEE LOM. Similar to Identifier in datacite. See identifier.
Publisher: Corresponds to dct:publisher and Publisher in DataCite. The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role. For software, use Publisher for the code repository. If there is an entity other than a code repository, that "holds, archives, publishes, prints, distributes, releases, issues, or produces" the code, use the property Contributor/contributorType/hostingInstitution for the code repository. See publisher.
Subject: Defaults to NULL. See subject to add subject descriptions to your dataset.
Date: Corresponds to a point or period of time associated with an event in the lifecycle of the resource. dct:date. Date is also recommended for discovery in datacite.
Source: A related resource from which the described resource is derived. See dct:source and dataset_source.
Language: The primary language of the resource. Allowed values are taken from IETF BCP 47, ISO 639-1 language code. See language. Corresponds to Language in Datacite.
Format: The file format, physical medium, or dimensions of the resource. dct:format Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types, formerly known as MIME. It is similar to Format in datacite.
Rights: Corresponds to dct:rights and datacite Rights. Information about rights held in and over the resource. Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights. See rights.
Relation: A related resource. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. See: dct:relation. Similar to RelatedItem in datacite, which is recommended for discovery.
Description: An account of the resource. It may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource. dct:description. In datacite it is recommended for discovery. See description.
Type: The nature or genre of the resource. Recommended best practice is to use a controlled vocabulary such as the DCMI Type Vocabulary DCMITYPE. For a dataset, the correct term is Dataset. To describe the file format, physical medium, or dimensions of the resource, use the Format element.
overwrite: If pre-existing metadata properties should be overwritten, defaults to TRUE.

Details

DataCite is a leading global non-profit organisation that provides persistent identifiers (DOIs) for research data and other research outputs. Organizations within the research community join DataCite as members to be able to assign DOIs to all their research outputs. This way, their outputs become discoverable and associated metadata is made available to the community. DataCite then develops additional services to improve the DOI management experience, making it easier for our members to connect and share their DOIs with the broader research ecosystem and to assess the use of their DOIs within that ecosystem. DataCite is an active participant in the research community and promotes data sharing and citation through community-building efforts and outreach activities.

The ResourceType property will be by definition "Dataset". The Size attribute (e.g. bytes, pages, inches, etc.) will automatically added to the dataset.

Examples

Run this code

dct_iris <- dublincore_add(
                   x = iris,
                   Title = "Iris Dataset",
                   Creator = person("Anderson", "Edgar", role = "aut"),
                   Publisher = "American Iris Society",
                   Source = "https://doi.org/10.1111/j.1469-1809.1936.tb02137.x",
                   Date = 1935,
                   Language = "en"
                   )

dublincore(dct_iris)