Skip to contents

Create a related item

Source: R/related_item.R
related_item.Rd

Create a RelatedIdentifier, attribute, which is recommended for discovery in DataCite.

Usage

related_item(
  Identifier,
  Creator,
  Title,
  relatedIdentifierType,
  relationType,
  schemeURI = NA_character_,
  schemeType = NA_character_,
  resourceTypeGeneral = NA_character_,
  PublicationYear = NULL,
  Volume = NULL,
  Issue = NULL,
  Number = NULL,
  numberType = NULL,
  firstPage = NULL,
  lastPage = NULL,
  Publisher = NULL,
  Edition = NULL,
  Contributor = NULL
)

Arguments

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.

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.

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.
See dataset_title for adding further titles.

relatedIdentifierType

See relatedIdentifierType.

relationType

See relationType.

schemeURI

See schemeURI.

schemeType

See schemeType.

resourceTypeGeneral

The general type of a resource or file. See resource_type_general for allowed values and validation.

PublicationYear

The year when the data was or will be made publicly available in YYYY format.See publication_year.

Volume

The volume of the related item (optional).

Issue

The issue number of the related item (optional).

Number

The number of the related item (optional).

numberType

The type of the number (optional).

firstPage

The first page of the related item (optional).

lastPage

The first page of the related item (optional).

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.

Edition

The edition of the related item (optional).

Contributor

Recommended for discovery. The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.

Value

a related item.

See also

Other metadata functions: datacite(), dublincore()

Examples

my_item <- related_item (Identifier = "https://zenodo.org/record/5703222#.YZYkm2DMLIU",
                         Creator = person ("Daniel", "Antal", role = "aut"),
                         Publisher = "Zenodo",
                         PublicationYear = 2022,
                         relatedIdentifierType = "DOI",
                         relationType = "CompiledBy",
                         schemeURI = "URI",
                         resourceTypeGeneral = "Dataset")