datacite: Create a bibentry object with DataCite metadata fields

In dataset: Create Data Frames that are Easier to Exchange and Reuse

Create a bibentry object with DataCite metadata fields

Description

Add metadata conforming the DataCite Metadata Schema.

Usage

as_datacite(x, type = "bibentry", ...)

datacite(
  Title,
  Creator,
  Identifier = NULL,
  Publisher = NULL,
  PublicationYear = NULL,
  Subject = subject_create(term = "data sets", subjectScheme =
    "Library of Congress Subject Headings (LCSH)", schemeURI =
    "https://id.loc.gov/authorities/subjects.html", valueURI =
    "http://id.loc.gov/authorities/subjects/sh2018002256"),
  Type = "Dataset",
  Contributor = NULL,
  Date = ":tba",
  DateList = NULL,
  Language = NULL,
  AlternateIdentifier = ":unas",
  RelatedIdentifier = ":unas",
  Format = ":tba",
  Version = "0.1.0",
  Rights = ":tba",
  Description = ":tba",
  Geolocation = ":unas",
  FundingReference = ":unas"
)

is.datacite(x)

## S3 method for class 'datacite'
is.datacite(x)

Arguments

x	An object that is tested if it has a class "datacite".
type	A DataCite 4.4 metadata can be returned as a type="list", a type="dataset_df", a type="bibentry" (default) or type="ntriples".
...	Optional parameters to add to a datacite object. author=person("Jane", "Doe") adds an author to the citation object if type="dataset". as_datacite(orange_df, type="list")
Title	The name(s) or title(s) by which a resource is known. May be the title of a dataset or the name of a piece of software. Similar to dct:title.
Creator	The main researchers involved in producing the data, or the authors of the publication, in priority order. To supply multiple creators, repeat this property.
Identifier	The Identifier is a unique string that identifies a resource. For software, determine whether the identifier is for a specific version of a piece of software, (per the Force11 Software Citation Principles, or for all versions. Similar to dct:title in dublincore().
Publisher	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. Mandatory in DataCite, and similar to dct:publisher. See publisher().
PublicationYear	The year when the data was or will be made publicly available in YYYY format.See publication_year().
Subject	Recommended for discovery. Subject, keyword, classification code, or key phrase describing the resource. Similar to dct:subject. Use subject to properly add a key phrase from a controlled vocabulary and create structured Subject objects with subject_create.
Type	Defaults to Dataset. The DataCite resourceType definition refers back to dcm:type. The Type$resourceTypeGeneral is set to "Dataset", while the user can set a more specific Type$resourceType value.
Contributor	Recommended for discovery. The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
Date	A character string in any of the following formats: YYYY, YYYY-MM-DD or YYYY-MM-DDThh:mm:ssTZD, or an R Date or POSIXct object. A list of dates (parameter DateList) is not yet implemented.
DateList	DataCite 4.4 allows to set multiple dates to a resource, they should be added as a list. Currently not yet implemented. See: datacite:Date.
Language	The primary language of the resource. Allowed values are taken from IETF BCP 47, ISO 639-1 language code. See language().
AlternateIdentifier	An identifier or identifiers other than the primary Identifier applied to the resource being registered. This may be any alphanumeric string unique within its domain of issue. It may be used for local identifiers. AlternateIdentifier should be used for another identifier of the same instance (same location, same file). Defaults to ":unas" for unassigned values.
RelatedIdentifier	Recommended for discovery. Defaults to ":unas" for unassigned values. Similar to dct:relation.
Format	Technical format of the resource. Use file extension or MIME type where possible, e.g., PDF, XML, MPG or application/pdf, text/xml, video/mpeg. Similar to dct:format.
Version	Free text. Suggested practice: track major_version.minor_version. Defaults to "0.1.0". See version.
Rights	Any rights information for this resource. The property may be repeated to record complex rights characteristics, but this is not yet supported. Free text. See rights. Defaults to ":tba".
Description	Recommended for discovery. All additional information that does not fit in any of the other categories. It may be used for technical information—a free text. Defaults to ":tba". Similar to dct:description.
Geolocation	Recommended for discovery. Spatial region or named place where the data was gathered or about which the data is focused. See geolocation().
FundingReference	Information about financial support (funding) for the resource being registered. Defaults to ":unas" for unassigned values. Complex types with subproperties are not yet implemented.

Details

DataCite is a leading global non-profit organisation that provides persistent identifiers (DOIs) for research data and other research outputs. Organisations 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.

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

Value

as_datacite(x, type) returns the DataCite bibliographical metadata of x either as a list, a bibentry object, an N-Triples text serialisation or a dataset_df object.

datacite() creates a utils::bibentry object extended with standard Dublin Core bibliographical metadata, as_datacite() retrieves the contents of this bibentry object of a dataset_df from its attributes, and returns the contents as list, dataset_df, or bibentry object.

is.datacite(x) returns a logical values (if the object x is of class datacite).

Source

DataCite 4.3 Mandatory Properties and DataCite 4.3 Optional Properties

See Also

Other bibentry functions: as_dublincore(), get_bibentry()

Examples

datacite(
  Title = "Growth of Orange Trees",
  Creator = c(
    person(
      given = "N.R.",
      family = "Draper",
      role = "cre",
      comment = c(VIAF = "http://viaf.org/viaf/84585260")
    ),
    person(
      given = "H",
      family = "Smith",
      role = "cre"
    )
  ),
  Publisher = "Wiley",
  Date = 1998,
  Language = "en"
)

# Bibliographic metadata as bibentry...
as_datacite(orange_df)

# ... or a list:
as_datacite(orange_df, "list")

dataset documentation built on June 8, 2025, 10:15 a.m.