Package index

Core workflow

Main workflow

Create, write and validate a CITATION.cff file in one command.

cff_write()

Write a CITATION.cff file

Other core functions

Create, modify and validate 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

Inspect valid keys and fields from the Citation File Format schema (v1.2.0).

cff_schema_keys() cff_schema_keys_license() cff_schema_definitions_person() cff_schema_definitions_entity() cff_schema_definitions_refs()

Schema utils

Class system

Learn about the cff class system and S3 methods implemented by cffr.

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

Additional features

Coerce objects

Coerce R objects to different classes (cff, person and bibentry) used by the package.

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 CITATION.cff, BibTeX and R citation files.

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

Convert between BibTeX markup and CFF objects.

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

Git and GitHub helpers

Keep CITATION.cff synchronized with package metadata.

cff_gha_update()

Install a cffr GitHub Action

cff_git_hook_install() cff_git_hook_remove()

Use a git pre-commit hook

Datasets

Package datasets used for metadata mapping.

cran_to_spdx

Mapping between License fields and SPDX

Deprecated functions

About the package

cffr cffr-package

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