Package: citeme 0.1.4

Thierry Onkelinx

citeme: Manage Person and Organisation Information

Manage person and organisation information with validation and formatting capabilities. Provides R6 classes for managing organisations and their members, with support for multiple languages, ORCID identifiers, ROR identifiers, licensing requirements, publisher information, and integration with citation management systems.

Authors:Thierry Onkelinx [aut, cre], Research Institute for Nature and Forest [cph, fnd, pbl]

citeme_0.1.4.tar.gz
citeme_0.1.4.zip(r-4.7)citeme_0.1.4.zip(r-4.6)citeme_0.1.4.zip(r-4.5)
citeme_0.1.4.tgz(r-4.6-any)citeme_0.1.4.tgz(r-4.5-any)
citeme_0.1.4.tar.gz(r-4.7-any)citeme_0.1.4.tar.gz(r-4.6-any)
citeme_0.1.4.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
citeme/json (API)

# Install 'citeme' in R:
install.packages('citeme', repos = c('https://inbo.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/inbo/citeme/issues

Pkgdown/docs site:https://inbo.github.io

On CRAN:

Conda:

quarto

4.73 score 2 packages 5 scripts 44 exports 18 dependencies

Last updated from:b107ca1ee4. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK147
source / vignettesOK182
linux-release-x86_64OK136
macos-release-arm64OK151
macos-oldrel-arm64OK154
windows-develOK134
windows-releaseOK122
windows-oldrelOK105
wasm-releaseOK127

Exports:add_badgesadd_individualask_emailask_keywordsask_languageask_new_licenseask_orcidask_rorask_urlask_yes_nocache_orgcitation_metacoalesceget_available_organisationsget_default_org_listhas_person_roleinbo_org_listindividual2badgeindividual2dfindividual2personis_repositoryis_tracked_not_modifiedlicense_local_remotemenu_firstnew_org_itemnew_org_listorg_itemorg_listorg_list_from_urlorganisation2dfselect_individualselect_licenseselect_person_rolessh_httpstore_individualsstore_organisationsstored_organisationsvalidate_citationvalidate_emailvalidate_languagevalidate_license_listvalidate_orcidvalidate_rorvalidate_url

Dependencies:askpassassertthatclicredentialscurldescevaluategerthighrjsonliteknitropensslR6rstudioapisysxfunyamlzip

Interactive Input and Validation
Introduction | Interactive Input Functions | Yes/No Questions | ORCID Identifiers | ROR Identifiers | Email Addresses | URLs | Language Codes | Licenses | Menu Selection | Validation Functions | ORCID Validation | ROR Validation | Email Validation | URL Validation | Language Code Validation | Integration with Interactive Functions | Non-Interactive Behaviour | Error Handling | Best Practices | Common Patterns | Validating User Input | Cleaning Existing Data | Optional Fields | Batch Processing | Related Functions
Rendered frominteractive_input.qmdusingquarto::html

Last update: 2026-06-11
Started: 2026-05-08

Organisations
Why bother setting up an org_list? | The org_item class | Roles: rightsholder, funder, and publisher | The org_list class | Creating an org_list programmatically | Creating an org_list interactively | Getting the default org_list for a project | Adding an org_item to an existing org_list | The built-in INBO organisation list | FAQ
Rendered fromorganisation.qmdusingquarto::html

Last update: 2026-06-11
Started: 2026-05-08

Working with Individuals
Introduction | Why Use Individual Helper Functions? | Storing Individual Information | Selecting and Reusing Individuals | Converting Individual Information | To Person Objects | To Badge Format | To Data Frames | Adding Individuals to Files | Role Mapping for Different File Types | Helper Functions for Roles | Checking Person Roles | Selecting Roles Interactively | Typical Workflow | Working with Multiple Languages | Best Practices | Related Functions
Rendered fromindividuals.qmdusingquarto::html

Last update: 2026-06-11
Started: 2026-05-08

Readme and manuals

Help Manual

Help pageTopics
add badges to a READMEadd_badges
Add an individual to a fileadd_individual
Ask for an e-mail addressask_email
Ask for keywords This function prompts the user to enter one or more keywords separated by ;. It will continue to prompt the user until at least one keyword is provided. The function returns a character vector of the entered keywords, with leading and trailing whitespace removed.ask_keywords
Ask for a languageask_language
Ask one or more licenses.ask_new_license
Ask for an ORCID iDask_orcid
Ask for an RORask_ror
Ask an URLask_url
Function to ask a simple yes no questionask_yes_no
Cache organisation list from URLcache_org
The 'citation_meta' R6 classcitation_meta
coalescecoalesce
Get the list of available organisationsget_available_organisations
Get the default organization listget_default_org_list
Does a person object has a given role?has_person_role
The INBO organisation listinbo_org_list
Create a markdown badge for an individualindividual2badge
Convert person object in a data.frame.individual2df
Select the individual information to use as a 'person' objectindividual2person
Determine if a directory is in a git repositoryis_repository
Check if a file is tracked and not modifiedis_tracked_not_modified
Create a data frame mapping local license file names to remote license URLslicense_local_remote
Improved version of 'utils::menu()'menu_first
Interactively create a new 'org_item'new_org_item
Interactively create a new organisation listnew_org_list
The 'org_item' R6 classorg_item
The 'org_list' R6 classorg_list
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.org_list_from_url
Convert organisation object to a data.frameorganisation2df
Select an individual from the local database or add a new individual.select_individual
Select a license for a project, package or datasetselect_license
Select the person object with a given roleselect_person_role
Convert SSH URL to HTTP URLssh_http
Store individual details for later usagestore_individuals
Store organisation details for later usagestore_organisations
Retrieve stored organisation informationstored_organisations
Validate a citation metadata objectvalidate_citation
Check if a vector contains valid emailvalidate_email
Validate language codevalidate_language
Validate a license listvalidate_license_list
Validate the structure of an ORCID iDvalidate_orcid
Validate RORvalidate_ror
Validate URLvalidate_url