Skip to contents

Function reference

The Whole Game

The 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, modify and write and cff objects.

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

Citation File Format schema

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

Additional features

Coercing objects

Coerce R objects into different classes (cff, person, bibentry) and more.

as_bibentry()
Create bibentry objects from several sources
as_cff()
Coerce lists, person and bibentry objects to cff
as_cff_person()
Coerce R objects to cff_pers_lst objects (cff persons)

Read and write files

Read and write local files on different formats (CFF files, BibTeX, etc.).

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()
Write a CITATION.cff file
cff_write_bib() cff_write_citation()
Export R objects to different file types

BibTeX helpers

Functions that works with BibTeX markup language.

as_bibentry()
Create bibentry objects from several 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 different file types

Continuous Integration

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

Datasets

cran_to_spdx
Mapping between License fields and SPDX

About the package

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