Package index

R6 classes

citation_meta

The citation_meta R6 class

org_item

The org_item R6 class

org_list

The org_list R6 class

Helper functions for individuals

add_individual()

Add an individual to a file

individual2badge()

Create a markdown badge for an individual

individual2df()

Convert person object in a data.frame.

individual2person()

Select the individual information to use as a person object

select_individual()

Select an individual from the local database or add a new individual.

store_individuals()

Store individual details for later usage

Helper functions for organisations

cache_org()

Cache organisation list from URL

get_available_organisations()

Get the list of available organisations

get_default_org_list()

Get the default organization list

inbo_org_list()

The INBO organisation list

new_org_item()

Interactively create a new org_item

new_org_list()

Interactively create a new organisation list

org_list_from_url()

Get the default organisation list from a git URL This function retrieves the default organisation list from a git URL. It checks if the organisation list is already cached in the user's R configuration. If it is, it returns the cached version. If not, it attempts to retrieve the organisation list from the specified git URL and caches it for future use.

select_license()

Select a license for a project, package or dataset

Interactively asking for input

ask_email()

Ask for an e-mail address

ask_language()

Ask for a language

ask_new_license()

Ask one or more licenses.

ask_orcid()

Ask for an ORCID iD

ask_ror()

Ask for an ROR

ask_url()

Ask an URL

ask_yes_no()

Function to ask a simple yes no question

menu_first()

Improved version of utils::menu()

Validating input

validate_citation()

Validate a citation metadata object

validate_email()

Check if a vector contains valid email

validate_language()

Validate language code

validate_license()

Validate a license list

validate_orcid()

Validate the structure of an ORCID iD

validate_ror()

Validate ROR

validate_url()

Validate URL

License utilities

license_local_remote()

Create a data frame mapping local license file names to remote license URLs

Git utilities

is_repository()

Determine if a directory is in a git repository

is_tracked_not_modified()

Check if a file is tracked and not modified

ssh_http()

Convert SSH URL to HTTP URL

Utils

add_badges()

add badges to a README

coalesce()

coalesce