Skip to contents

Package index

Create and maintain CITATION.cff files

Main workflow for R package authors.

cff_write()
Write a CITATION.cff file
cff_create()
Create a cff object from multiple sources
cff()
Create cff objects from direct inputs
cff_validate()
Validate a CITATION.cff file or a cff object
cff_modify()
Modify a cff object

Read and write citation metadata

Read metadata

cff_read() cff_read_cff_citation() cff_read_description() cff_read_citation() cff_read_bib()
Read an external file as a cff object
cff_read_bib_text()
Read BibTeX markup as a cff_ref_lst object

Write metadata

cff_write()
Write a CITATION.cff file
cff_write_bib() cff_write_citation()
Export R objects to multiple file types

Convert between CFF, R and BibTeX

Coercion helpers

as_bibentry()
Create bibentry objects from multiple sources
as_cff()
Coerce lists and citation objects to cff
as_cff_person()
Coerce R objects to cff_pers_lst objects

BibTeX helpers

as_bibentry()
Create bibentry objects from multiple sources
cff_read() cff_read_cff_citation() cff_read_description() cff_read_citation() cff_read_bib()
Read an external file as a cff object
cff_read_bib_text()
Read BibTeX markup as a cff_ref_lst object
cff_write_bib() cff_write_citation()
Export R objects to multiple file types

Inspect CFF schema values

cff_schema_keys() cff_schema_keys_license() cff_schema_definitions_person() cff_schema_definitions_entity() cff_schema_definitions_refs()
Inspect CFF schema values

Automation

Helpers for keeping CITATION.cff synchronized with package metadata.

cff_gha_update()
Install a cffr GitHub Actions workflow
cff_git_hook_install() cff_git_hook_remove()
Use a git pre-commit hook [Experimental]

Data

cran_to_spdx
Mapping between License fields and SPDX

Package internals and lifecycle

Class system

cff_class cff_ref cff_ref_lst cff_pers cff_pers_lst print.cff c.cff [.cff_ref_lst [.cff_pers_lst as.data.frame.cff as.data.frame.cff_pers_lst as.data.frame.cff_pers as.data.frame.cff_ref_lst as.data.frame.cff_ref head.cff tail.cff as.list.cff toBibtex.cff toBibtex.cff_ref_lst toBibtex.cff_ref toBibtex.cff_pers_lst toBibtex.cff_pers as.person.cff_pers as.person.cff_pers_lst as.person.cff as.person.cff_ref as.person.cff_ref_lst
The cff class

Deprecated functions

cff_parse_citation() deprecated
Previous API: Parse a bibentry object to cff
cff_from_bibtex() deprecated
Previous API: Create a cff object from BibTeX entries
cff_parse_person() cff_parse_person_bibtex() deprecated
Previous API: Parse a person to cff
cff_extract_to_bibtex() cff_to_bibtex() deprecated
Previous API: Create BibTeX entries from multiple sources
write_bib() write_citation() deprecated
Previous API: Write files

Package overview

cffr cffr-package
cffr: Generate Citation File Format ('CFF') Metadata for R Packages