cff_write_misc: Export R objects to multiple file types

In cffr: Generate Citation File Format ('CFF') Metadata

Export R objects to multiple file types

Description

Export R objects representing citations to specific file formats:

• cff_write_bib() creates a .bib file.

• cff_write_citation() creates an R citation file as described in Section 1.9 of Writing R Extensions (R Core Team 2026).

Usage

cff_write_bib(
  x,
  file = tempfile(fileext = ".bib"),
  append = FALSE,
  verbose = TRUE,
  ascii = FALSE,
  ...
)

cff_write_citation(
  x,
  file = tempfile("CITATION_"),
  append = FALSE,
  verbose = TRUE,
  ...
)

Arguments

x	A bibentry or a cff object.
file	Name of the file to be created. If NULL, the lines are displayed instead.
append	A logical value. If TRUE, append entries to an existing file.
verbose	A logical value. If TRUE, display informative messages.
ascii	A logical value. If TRUE, write entries using ASCII characters only.
...	Arguments passed on to as_bibentry.cff, as_bibentry.cff_ref, as_bibentry.cff_ref_lst what Fields to extract from a full cff object. It can be: preferred: Create a single entry with the main citation information of the package (key preferred-citation). references: Extract all entries of the references key. all: Extract both the preferred-citation and references keys. See vignette("r-cff", package = "cffr").

Details

When x is a cff object, it is converted to BibTeX using toBibtex.cff().

For security reasons, if the file already exists, the function creates a backup copy in the same directory.

Value

Invisibly returns NULL. This function is called for its side effect of writing a file or displaying its contents.

References

R Core Team (2026). Writing R Extensions. https://cran.r-project.org/doc/manuals/r-release/R-exts.html.

See Also

vignette("bibtex-cff", package = "cffr"), knitr::write_bib() and the following packages:

• bibtex.

• RefManageR.

• rbibutils.

Work with BibTeX metadata: as_bibentry(), cff_read(), cff_read_bib_text(), encoded_utf_to_latex()

Write citation metadata files: cff_write()

Examples

bib <- bibentry("Misc",
  title = "My title",
  author = "Fran Pérez"
)

my_temp_bib <- tempfile(fileext = ".bib")

cff_write_bib(bib, file = my_temp_bib)

cat(readLines(my_temp_bib), sep = "\n")

cff_write_bib(bib, file = my_temp_bib, ascii = TRUE, append = TRUE)

cat(readLines(my_temp_bib), sep = "\n")
# Create an R citation file.
# Use a system file.
f <- system.file("examples/preferred-citation-book.cff", package = "cffr")
a_cff <- cff_read(f)

out <- file.path(tempdir(), "CITATION")
cff_write_citation(a_cff, file = out)

# Check by reading with a meta object.
meta <- packageDescription("cffr")
meta$Encoding <- "UTF-8"

utils::readCitationFile(out, meta)

cffr documentation built on Aug. 24, 2026, 5:11 p.m.