datacite: Create a Bibentry Object with DataCite Metadata Fields

In dataset: Create Data Frames for Exchange and Reuse

Create a Bibentry Object with DataCite Metadata Fields

Description

Constructs a bibliographic metadata record conforming to the DataCite Metadata Schema. The resulting object is stored as a modified utils::bibentry() enriched with structured Dublin Core and DataCite-compliant metadata.

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)

## S3 method for class 'datacite'
print(x, ...)

Arguments

x	An object that is tested if it has a class "datacite".
type	A DataCite 4.4 metadata can be returned as: "list", "dataset_df", "bibentry" (default), or "ntriples".
...	Optional parameters to add to a datacite object. For example, author = person("Jane", "Doe") adds an author if type = "dataset_df".
Title	The name(s) by which the resource is known. Similar to dct:title.
Creator	One or more utils::person() objects describing the main authors or contributors responsible for creating the resource.
Identifier	A persistent identifier (e.g., DOI or URI). May refer to a specific version or all versions of the resource.
Publisher	The name of the organization that holds, publishes, or distributes the resource. Required by DataCite. See publisher().
PublicationYear	The year of public availability (in YYYY format). See publication_year().
Subject	A topic, keyword, or classification term. See subject() and subject_create() for structured vocabularies.
Type	The resource type. Defaults to "Dataset" for general use. See dcm:type.
Contributor	An individual or institution that contributed to the development, distribution, or curation of the resource.
Date	A date in "YYYY", "YYYY-MM-DD" or ISO datetime format. Can also be a Date or POSIXct object.
DateList	A list of multiple dates. Currently not supported.
Language	Language code as per IETF BCP 47 / ISO 639-1. See language().
AlternateIdentifier	Optional local or secondary identifier. Defaults to ":unas".
RelatedIdentifier	Related resources (e.g., prior versions, papers). Defaults to ":unas".
Format	A technical format (e.g., "application/pdf", "text/csv").
Version	A free-text version string (e.g., "1.0.0"). Defaults to "0.1.0". See version().
Rights	Licensing or usage restrictions for the resource. Defaults to ":tba". See rights().
Description	Free-text summary or additional information. Defaults to ":tba".
Geolocation	Geographic location covered or referenced by the resource. See geolocation().
FundingReference	Information about funding or financial support. Defaults to ":unas". Structured funding metadata not yet implemented.

Details

DataCite is a leading non-profit organization that provides persistent identifiers (DOIs) for research data and other research outputs. Members of the research community use DataCite to register datasets with globally resolvable metadata for citation and discovery.

This function sets "Dataset" as the default resource type. The Size attribute (e.g., bytes, pages, etc.) is automatically added if available.

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.

A utils::bibentry() object with DataCite-compliant fields. Use as_datacite() to extract the metadata as a list or bibentry object.

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

Source

• DataCite 4.3 Mandatory Properties

• DataCite 4.3 Optional Properties

See Also

Learn more in the vignette: bibrecord

Other bibrecord functions: as_dublincore(), bibrecord()

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"
)

# Extract bibliographic metadata
as_datacite(orange_df)

# As a list
as_datacite(orange_df, "list")

dataset documentation built on Nov. 16, 2025, 5:06 p.m.