Skip to content

Commit

Permalink
Update links and URIs
Browse files Browse the repository at this point in the history
  • Loading branch information
antaldaniel committed Jan 8, 2024
1 parent 3af4693 commit 92eaa0e
Show file tree
Hide file tree
Showing 10 changed files with 67 additions and 51 deletions.
46 changes: 26 additions & 20 deletions R/datacite.R
Original file line number Diff line number Diff line change
@@ -1,54 +1,60 @@
#' @title Add or get DataCite metadata
#' @description Add or retrieve metadata conforming
#' the \href{https://schema.datacite.org/}{DataCite Metadata Schema}.
#' @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.
#' @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.
#' @details The \code{ResourceType} property will be by definition "Dataset".
#' The \code{Size} attribute (e.g. bytes, pages, inches, etc.) will automatically added to the dataset.
#' @param 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 \href{https://purl.org/dc/elements/1.1/title}{dct:title}.\cr
#' The \code{Size} attribute (e.g. bytes, pages, inches, etc.) will automatically added to
#' the dataset.
#' @param 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
#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/title/}{dct:title}.\cr
#' @param 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.
#' @param 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
#' \href{https://force11.org/info/software-citation-principles-published-2016/}{Force11 Software Citation Principles},
#' or for all versions. Similar to \code{dct:title} in \code{\link{dublincore}}.
#' or for all versions. Similar to \code{dct:title} in [dublincore()].
#' @param 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. 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. Corresponds to dct:Publisher in
#' \code{\link{dublincore}}.
#' [dublincore()].
#' @param PublicationYear The year when the data was or will be made publicly available in
#' \code{YYYY} format.See \code{\link{publication_year}}.
#' \code{YYYY} format.See [publication_year()].
#' @param Subject Recommended for discovery. Subject, keyword, classification code, or key
#' phrase describing the resource. Similar to \href{https://purl.org/dc/elements/1.1/subject}{dct:subject}. \cr
#' phrase describing the resource. Similar to
#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/subject/}{dct:subject}. \cr
#' Use \code{\link{subject}} to properly add a key phrase from a controlled vocabulary
#' and create structured Subject objects with \code{\link{subject_create}}.
#' @param Contributor Recommended for discovery. The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
#' @param 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
#' \code{dct:publisher}. See \code{\link{publisher}}.
#' \code{dct:publisher}. See [publisher()].
#' @param Type Defaults to \code{Dataset}.
#' The DataCite resourceType definition refers back to
#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#https://purl.org/dc/elements/1.1/type}{dcm:type}.
#' The \code{Type$resourceTypeGeneral} is set to \code{Dataset}, while the user can set a more
#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/type/}{dcm:type}.
#' The \code{Type$resourceTypeGeneral} is set to \code{"Dataset"}, while the user can set a more
#' specific \code{Type$resourceType} value.
#' @param Language The primary language of the resource. Allowed values are taken from
#' IETF BCP 47, ISO 639-1 language code. See \code{\link{language}}.
#' IETF BCP 47, ISO 639-1 language code. See [language()].
#' @param 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. \code{AlternateIdentifier} should be used for another
#' identifier of the same instance (same location, same file).
#' @param RelatedIdentifier Recommended for discovery. Similar to \href{https://purl.org/dc/elements/1.1/relation}{dct:relation}.
#' @param Format Technical format of the resource. Similar to \href{https://purl.org/dc/elements/1.1/format}{dct:format}.
#' @param RelatedIdentifier Recommended for discovery. Similar to
#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/relation/}{dct:relation}.
#' @param Format Technical format of the resource.
#' Similar to \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/format/}{dct:format}.
#' @param Version Free text. Suggested practice: track major_version.minor_version. See \code{\link{version}}.
#' @param Rights Any rights information for this resource. The property may be repeated to record complex rights characteristics.
#' Free text. See \code{\link{rights}}.
Expand All @@ -57,9 +63,9 @@
#' \href{https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#8-date}{datacite:Date}.
#' @param 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.
#' Similar to \href{https://purl.org/dc/elements/1.1/description}{dct:description}.
#' Similar to \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/description/}{dct:description}.
#' @param Geolocation Recommended for discovery. Spatial region or named place where the data was gathered
#' or about which the data is focused. See \code{\link{geolocation}}.
#' or about which the data is focused. See [geolocation()].
#' @param FundingReference Information about financial support (funding) for the resource
#' being registered.
#' @return A \code{utils::\link[utils]{bibentry}} object DataCite attributes.
Expand Down
2 changes: 1 addition & 1 deletion R/dataset_title.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#' yet implemented.
#' @param x A dataset object created with \code{dataset::\link{dataset}}.
#' @param value The name(s) or title(s) by which a resource is known. See:
#' \href{https://purl.org/dc/elements/1.1/title}{dct:title}.
#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/title}{dct:title}.
#' @return A string with the dataset's title; \code{set_dataset_title} returns
#' a dataset object with the changed (main) title.
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/datasource.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#' @description Get/set the optional \code{Source} property as an attribute to an
#' R object. Do not confuse with the base R \code{source()} function.
#' @details The \code{Source} is a related resource from which the described resource is
#' derived. See \href{https://purl.org/dc/elements/1.1/source}{dct:source}. In Datacite,
#' derived. See \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/source}{dct:source}. In Datacite,
#' the source is described by a \code{relatedIdentifierType} with the property
#' \code{relationType="isDerivedFrom"}.
#' @param x A dataset object created with \code{dataset::\link{dataset}}.
Expand Down
3 changes: 2 additions & 1 deletion R/description.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
#' @description Get/set the optional \code{Description} property as an attribute to an R object.
#' @details The \code{Description} is recommended for discovery in DataCite. All additional information that does not
#' fit in any of the other categories. May be used for technical information. A free text.
#' Similar to \href{https://purl.org/dc/elements/1.1/description}{dct:description}.
#' Similar to
#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/description/}{dct:description}.
#' @param x A dataset object created with \code{dataset::\link{dataset}}.
#' @param value The \code{Description} as a character set.
#' @param overwrite If the \code{Description} attribute should be overwritten. In case it is set to \code{FALSE},
Expand Down
44 changes: 25 additions & 19 deletions man/datacite.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/dataset_title.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/datasource_get.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/description.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions man/related_item.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 92eaa0e

Please sign in to comment.