Function reference • cffr

Main function

The main function of the package and likely to be the only one you would need.

cff_write(): Write a CITATION.cff file

Other core functions

Create, write and manipulate files and objects.

cff_create(): Create cff object

cff_read() cff() as.cff(): Read and manipulate cff objects

cff_validate(): Validate a CITATION.cff file or a cff object

cff_write(): Write a CITATION.cff file

Citation File Format schema

These functions provides lists of valid keys and fields as defined by the CFF schema.json (v1.2.0).

cff_schema_keys() cff_schema_keys_license() cff_schema_definitions_person() cff_schema_definitions_entity() cff_schema_definitions_refs(): Schema utils

Parsers

Helper functions to parse information.

cff_parse_citation(): Parse a bibentry to cff

cff_parse_person() cff_parse_person_bibtex(): Parse a person to cff

BibTeX

Convert CFF to BibTeX and viceversa

cff_from_bibtex(): Create a cff object from BibTeX entries

cff_to_bibtex(): Create BibTeX entries from several sources

write_bib(): Create a .bib file

write_citation(): Create a inst/CITATION file

cff_parse_citation(): Parse a bibentry to cff

Datasets

cran_to_spdx: Mapping between License fields and SPDX

Continuous Integration

cff_gha_update(): Install a cffr GitHub Action

cff_git_hook_install() cff_git_hook_remove(): Use a git pre-commit hook

About the package

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