A class containing a list of organisations
Active bindings
as_listThe list of org_item objects.
get_default_nameThe organisations default name.
get_default_funderThe default funder.
get_default_rightsholderThe default rightsholder.
get_emailThe organisations email.
get_gitThe git organisation URL.
get_listed_licensesReturn the available licenses.
get_languagesThe different languages of the organisations.
which_funderThe required rightsholders.
which_rightsholderThe required rightsholders.
Methods
Method add_item()
Add one or more org_item objects to the list.
Arguments
...One or more org_item objects.
Method check()
Check if the organisation list is compatible with the
default as set in the organisations git repository.
Arguments
xThe path to the project directory
Method get_allowed_licenses()
Return the allowed licenses.
Usage
org_list$get_allowed_licenses(
email = character(0),
type = c("package", "project", "data", "all")
)
Arguments
emailThe email addresses of the organisations.
Returns all available licenses if missing.
typeThe type of license to return.
Can be one of "package", "project", "data" or "all".
Method get_person()
Return the organisation with matching email as a person().
Usage
org_list$get_person(email, role = c("cph", "fnd"), lang)
Arguments
emailThe email address of the organisation.
roleThe role of the person to return.
langThe language to return the organisation name in.
Method get_zenodo_by_email()
Return a vector of Zenodo communities associated with the
organisations with matching email.
Usage
org_list$get_zenodo_by_email(email)
Arguments
emailThe email addresses to match against.
Returns
A character vector with the communities.
Method get_match()
Return the organisation with a matching name.
Arguments
nameThe name of the organisation to match.
Returns
A list with the organisation name, email and match ratio.
Method get_name_by_domain()
Return the organisation names with a matching email domain.
Usage
org_list$get_name_by_domain(email, lang)
Arguments
emailThe email address to match the domain against.
langThe language to return the organisation name in.
Details
The function extracts the domain from the email address and
matches it against the organisation email addresses.
If multiple organisations have the same domain,
the function returns all matching names.
If the language is not available for a specific organisation,
it will return the first available name.
Returns
A character vector with the organisation names.
Method get_pkgdown()
get_pkgdown The pkgdown author field
Usage
org_list$get_pkgdown(lang)
Arguments
langThe language to use for affiliation.
Method new()
Initialize a new org_list object.
Arguments
...One or more org_item objects.
gitAn optional string with the absolute path to a git
organisation.
E.g. "https://github.com/inbo"
Print the org_list object.
Method read()
Read the org_list object from an organisation.yml file.
Arguments
xThe path to the directory where the organisation.yml file
is stored.
Method validate_person()
Validate a person object given the org_list object.
Usage
org_list$validate_person(person, lang)
Arguments
personThe person object to validate.
langThe language to use for affiliation.
Method validate_rules()
Validate the rules for the rightsholder and funder.
Usage
org_list$validate_rules(rightsholder = person(), funder = person())
Arguments
rightsholderThe rightsholders as a person object.
funderThe funders as a person object.
Write the org_list object to an organisation.yml file.
Usage
org_list$write(x = ".", license = FALSE)
Arguments
xThe path to the directory where the organisation.yml file
should be written.
licenseWhether to include license information.
Returns
The path to the written organisation.yml file.
Method clone()
The objects of this class are cloneable with this method.
Usage
org_list$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
