project: Create a Project Metadata Object

Description

Create a Project Metadata Object

Usage

project(
  title,
  year = format(Sys.Date(), "%Y"),
  language = "en",
  type,
  author = NULL,
  publisher = NULL,
  identifier = NULL,
  description = NULL,
  subject = NULL,
  contributor = NULL,
  license = NULL,
  funding = NULL,
  version = NULL,
  ...
)

Value

An object of class "project" with standardized metadata fields.

Arguments

title: character(1)
project title.
year: character(1)
publication year, defaults to current year.
language: character(1)
primary language, defaults to "en".
type: character(1)
resource type, one of "Dataset", "Software", "Image", "Model", "Text", "Collection", "Other".
author: person(.)
person or organization objects created with person().
publisher: character(1)
name of the publishing entity.
identifier: character(1)
project identifier (e.g., DOI).
description: character(1)
abstract or description.
subject: character(.)
keywords or classification codes.
contributor: person(.)
additional contributors as person objects.
license: character(1)
license or rights statement.
funding: character(.)
funding information.
version: character(1)
version of the resource.
...: additional metadata elements as name-value pairs.

Examples

Run this code

myProj <- project(title = "example project",
                  author = c(person("Jane", "Smith", email = "jane@example.com",
                                    role = "aut",
                                    comment = c(ORCID = "0000-0001-2345-6789",
                                                affiliation = "University of Example",
                                                ROR = "https://ror.org/05gq02987")),
                             person("Robert", "Jones", role = c("aut", "cre"))),
                  publisher = "example consortium",
                  type = "Dataset",
                  identifier = "10.5281/zenodo.1234567",
                  description = "A comprehensive explanation",
                  subject = c("keyword", "subject"),
                  license = "CC-BY-4.0")

Run the code above in your browser using DataLab