From 51cc84f656a02568c179f4ccc6f2f341d441ce00 Mon Sep 17 00:00:00 2001 From: Ward Langeraert <60934857+wlangera@users.noreply.github.com> Date: Thu, 20 Jun 2024 14:27:03 +0200 Subject: [PATCH 1/2] Update organisation_class.R --- R/organisation_class.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/organisation_class.R b/R/organisation_class.R index f9ee83ab..144da51e 100644 --- a/R/organisation_class.R +++ b/R/organisation_class.R @@ -25,10 +25,10 @@ organisation <- R6Class( #' - `rightsholder`: the rightsholder. #' Defaults to `"Research Institute for Nature and Forest (INBO)"`. #' Set to `NA_character_` in case you don't want to set a rightsholder. - #' - `organisation`: a named list with one or more organisation defaults. + #' - `organisation`: a named list with one or more organisation default rules. #' The names of the element must match the e-mail domain name of the #' organisation. - #' Every element should be a named list containing ´affiliation` and + #' Every element should be a named list containing `affiliation` and #' `orcid`. #' `affiliation` is a character vector with the approved organisation #' names in one or more languages. From b31667565c75cf223300273f000492834766434e Mon Sep 17 00:00:00 2001 From: Thierry Onkelinx Date: Sun, 14 Jul 2024 14:41:02 +0200 Subject: [PATCH 2/2] update documentation --- R/organisation_class.R | 3 ++- man/organisation.Rd | 9 +++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/R/organisation_class.R b/R/organisation_class.R index 144da51e..62407c73 100644 --- a/R/organisation_class.R +++ b/R/organisation_class.R @@ -25,7 +25,8 @@ organisation <- R6Class( #' - `rightsholder`: the rightsholder. #' Defaults to `"Research Institute for Nature and Forest (INBO)"`. #' Set to `NA_character_` in case you don't want to set a rightsholder. - #' - `organisation`: a named list with one or more organisation default rules. + #' - `organisation`: a named list with one or more organisation default + #' rules. #' The names of the element must match the e-mail domain name of the #' organisation. #' Every element should be a named list containing `affiliation` and diff --git a/man/organisation.Rd b/man/organisation.Rd index a76835a4..aa2ca14f 100644 --- a/man/organisation.Rd +++ b/man/organisation.Rd @@ -76,10 +76,15 @@ Set to \code{NA_character_} in case you don't want to set a funder. \item \code{rightsholder}: the rightsholder. Defaults to \code{"Research Institute for Nature and Forest (INBO)"}. Set to \code{NA_character_} in case you don't want to set a rightsholder. -\item \code{organisation}: a named list with one or more organisation defaults. +\item \code{organisation}: a named list with one or more organisation default +rules. The names of the element must match the e-mail domain name of the organisation. -Every element should be a named list containing ´affiliation\code{and}orcid\code{. }affiliation\verb{is a character vector with the approved organisation names in one or more languages.}orcid = TRUE` indicated a mandatory ORCiD for every member. +Every element should be a named list containing \code{affiliation} and +\code{orcid}. +\code{affiliation} is a character vector with the approved organisation +names in one or more languages. +\code{orcid = TRUE} indicated a mandatory ORCiD for every member. Use an empty list in case you don't want to set this. } }