From c1bf5eeebcfb9b7be9d810cf752b5774772017b5 Mon Sep 17 00:00:00 2001 From: antaldaniel Date: Mon, 8 Jan 2024 16:47:22 +0100 Subject: [PATCH] URIs and links formatting --- R/dataset_title.R | 4 ++-- R/datasource.R | 5 +++-- R/dublincore.R | 2 +- man/dataset_title.Rd | 4 ++-- man/datasource_get.Rd | 5 +++-- man/dublincore.Rd | 2 +- 6 files changed, 12 insertions(+), 10 deletions(-) diff --git a/R/dataset_title.R b/R/dataset_title.R index d84c281..5fc58c4 100644 --- a/R/dataset_title.R +++ b/R/dataset_title.R @@ -2,9 +2,9 @@ #' @description Get or reset the dataset's main title. #' @details In the DataCite definition, several titles can be used; it is not #' yet implemented. -#' @param x A dataset object created with \code{dataset::\link{dataset}}. +#' @param x A dataset object created with [dataset()] or [as_dataset()]. #' @param value The name(s) or title(s) by which a resource is known. See: -#' \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/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 diff --git a/R/datasource.R b/R/datasource.R index e309d4a..3430415 100644 --- a/R/datasource.R +++ b/R/datasource.R @@ -2,8 +2,9 @@ #' @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://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 +#' 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}}. #' @param value The \code{Source} as a character string of lengths one. diff --git a/R/dublincore.R b/R/dublincore.R index df80ac3..e5a2d28 100644 --- a/R/dublincore.R +++ b/R/dublincore.R @@ -50,7 +50,7 @@ #' Examples of dimensions include size and duration. Recommended best practice is to use a controlled #' vocabulary such as the list of \href{https://www.iana.org/assignments/media-types/media-types.xhtml}{Internet Media Types, formerly known as MIME}. It is similar to \code{Format} in #' \code{\link{datacite}}. -#' @param rights Corresponds to \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/rights}{dct:rights} and +#' @param rights Corresponds to \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/rights/}{dct:rights} and #' \code{\link{datacite}} Rights. Information about rights held in and over the resource. #' Typically, rights information includes a statement about various property rights associated with the resource, #' including intellectual property rights. See \code{\link{rights}}. diff --git a/man/dataset_title.Rd b/man/dataset_title.Rd index 36faaf5..faf50c9 100644 --- a/man/dataset_title.Rd +++ b/man/dataset_title.Rd @@ -10,14 +10,14 @@ dataset_title(x) dataset_title(x, overwrite = FALSE) <- value } \arguments{ -\item{x}{A dataset object created with \code{dataset::\link{dataset}}.} +\item{x}{A dataset object created with \code{\link[=dataset]{dataset()}} or \code{\link[=as_dataset]{as_dataset()}}.} \item{overwrite}{If the attributes should be overwritten. In case it is set to \code{FALSE},it gives a warning with the current \code{title} property instead of overwriting it. Defaults to \code{FALSE}.} \item{value}{The name(s) or title(s) by which a resource is known. See: -\href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/title}{dct:title}.} +\href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/title/}{dct:title}.} } \value{ A string with the dataset's title; \code{set_dataset_title} returns diff --git a/man/datasource_get.Rd b/man/datasource_get.Rd index 4e5ee4f..4ffaa27 100644 --- a/man/datasource_get.Rd +++ b/man/datasource_get.Rd @@ -28,8 +28,9 @@ 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://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 +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"}. } \examples{ diff --git a/man/dublincore.Rd b/man/dublincore.Rd index 315b73f..2757003 100644 --- a/man/dublincore.Rd +++ b/man/dublincore.Rd @@ -89,7 +89,7 @@ Similar to \code{RelatedItem} in \code{\link{datacite}}, which is recommended fo \item{format}{The file format, physical medium, or dimensions of the dataset. See \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/source/}{DCMI: Format}.} -\item{rights}{Corresponds to \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/rights}{dct:rights} and +\item{rights}{Corresponds to \href{https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/rights/}{dct:rights} and \code{\link{datacite}} Rights. Information about rights held in and over the resource. Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights. See \code{\link{rights}}.}