Package: cffr 1.1.1

Diego Hernangómez

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

The Citation File Format version 1.2.0 <doi:10.5281/zenodo.5171937> is a human and machine readable file format which provides citation metadata for software. This package provides core utilities to generate and validate this metadata.

Authors:Diego Hernangómez [aut, cre, cph], João Martins [rev], Scott Chamberlain [rev]

cffr_1.1.1.tar.gz
cffr_1.1.1.tar.gz(r-4.5-noble)cffr_1.1.1.tar.gz(r-4.4-noble)
cffr_1.1.1.tgz(r-4.4-emscripten)cffr_1.1.1.tgz(r-4.3-emscripten)
cffr.pdf |cffr.html
cffr/json (API)
NEWS

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

Peer review:

Bug tracker:https://github.com/ropensci/cffr/issues

Datasets:

attributioncitationcreditcitation-filescffmetadata

34 exports 1.08 score 9 dependencies 2 dependents 83 scripts 1.2k downloads

Last updated 22 days agofrom:d280eb5394. Checks:OK: 2. Indexed: no.

TargetResultDate
Doc / VignettesOKAug 20 2024
R-4.5-linuxOKAug 20 2024

Exports:as_bibentryas_cffas_cff_personas.cffcffcff_createcff_extract_to_bibtexcff_from_bibtexcff_gha_updatecff_git_hook_installcff_git_hook_removecff_modifycff_parse_citationcff_parse_personcff_parse_person_bibtexcff_readcff_read_bibcff_read_bib_textcff_read_cff_citationcff_read_citationcff_read_descriptioncff_schema_definitions_entitycff_schema_definitions_personcff_schema_definitions_refscff_schema_keyscff_schema_keys_licensecff_to_bibtexcff_validatecff_writecff_write_bibcff_write_citationencoded_utf_to_latexwrite_bibwrite_citation

Dependencies:clicurldescjsonlitejsonvalidateR6RcppV8yaml

BibTeX and CFF

Rendered frombibtex_cff.Rmdusingknitr::rmarkdownon Aug 20 2024.

Last update: 2024-08-17
Started: 2022-01-04

cffr: Generate Citation File Format Metadata for R Packages

Rendered frompaper.Rmdusingknitr::rmarkdownon Aug 20 2024.

Last update: 2024-08-17
Started: 2021-11-11

From R to CFF

Rendered fromcrosswalk.Rmdusingknitr::rmarkdownon Aug 20 2024.

Last update: 2024-08-17
Started: 2021-11-04

Manipulating Citations with cffr

Rendered fromcffr.Rmdusingknitr::rmarkdownon Aug 20 2024.

Last update: 2024-04-10
Started: 2021-11-04

Readme and manuals

Help Manual

Help pageTopics
Create 'bibentry' objects from several sourcesas_bibentry as_bibentry.cff as_bibentry.cff_ref as_bibentry.cff_ref_lst as_bibentry.character as_bibentry.default as_bibentry.list as_bibentry.NULL
Coerce lists, 'person' and 'bibentry' objects to 'cff'as.cff as_cff as_cff.bibentry as_cff.Bibtex as_cff.default as_cff.list as_cff.person
Coerce *R* objects to 'cff_pers_lst' objects ('cff' persons)as_cff_person as_cff_person.character as_cff_person.default as_cff_person.person
Create 'cff' objects from direct inputscff
Create a 'cff' object from several sourcescff_create
Install a 'cffr' GitHub Actioncff_gha_update
Use a git pre-commit hook *[Experimental]*cff_git_hook cff_git_hook_install cff_git_hook_remove
Modify a 'cff' objectcff_modify
Read an external file as a 'cff' objectcff_read cff_read_bib cff_read_cff_citation cff_read_citation cff_read_description
Read BibTeX markup as a 'cff_ref_lst' objectcff_read_bib_text
Schema utilscff_schema cff_schema_definitions_entity cff_schema_definitions_person cff_schema_definitions_refs cff_schema_keys cff_schema_keys_license
Validate a 'CITATION.cff' file or a 'cff' objectcff_validate
Write a 'CITATION.cff' filecff_write
Export *R* objects to different file typescff_write_bib cff_write_citation
Mapping between 'License' fields and SPDXcran_to_spdx