bbt_write_bib: Write a bibliography file from Zotero citation keys

In paleolimbot/rbbt: R Interface to the Better BiBTex Zotero Connector

Write a bibliography file from Zotero citation keys

Description

Write a bibliography file to disk from a set of citation keys. To automatically generate a bibliography file from the items cited in your document when you Knit, place a line like this one in your RMarkdown YAML header:

bibliography: "`r rbbt::bbt_write_bib('bibliography.json', overwrite = TRUE)`"

Usage

bbt_write_bib(
  path,
  keys = bbt_detect_citations(),
  ignore = character(),
  translator = bbt_guess_translator(path),
  library_id = getOption("rbbt.default.library_id", 1),
  overwrite = FALSE,
  filter = identity
)

Arguments

path	The output path for the bibliography file. Must end with .json, .bib, or .yaml.
keys	A character vector of citation keys.
ignore	A character vector of keys to disregard (useful if bbt_detect_citations() gives spurious output).
translator	Type of bibliography file to create. Options are json (CSL-JSON), biblatex (BibLaTeX), bibtex (BibTeX), and yaml (CSL YAML). CSL-JSON is recommended if users are not specifically using a LaTeX citation processor.
library_id	You may have to pass a specific library ID if your options are not set to use globally unique keys. Set the rbbt.default.library_id to ensure this value is used by the addin. You can use bbt_library_id() to look up this value by name.
overwrite	Use TRUE to overwrite an existing file at path
filter	Pass a function that can be used to modify the output of bbt_bib() before it is written to path.

Value

The value of path (so that this function can be used in the 'bibliography' RMarkdown YAML field)

Note

Most users should use CSL-JSON format (.json) for their bibliographies.

RMarkdown's citation formatting uses CSL styles. These styles require CSL-JSON data. RMarkdown converts other data formats (e.g., BibLaTeX) to CSL-JSON. This is not lossless, and references other than journal articles may be inaccurate. This is the case even if outputting to PDF or TeX format.

Only use BibLaTeX or BibTeX if you are using pandoc arguments to specify an alternative citation engine for raw TeX output.

The default translator can be changed. For example: options(rbbt.default.translator = "json")

Examples

## Not run: 
bbt_write_bib("bibliography.json") # For CSL-JSON output (recommended)
bbt_write_bib("bibliography.bib")  # For BibLaTeX output

## End(Not run)

paleolimbot/rbbt documentation built on Nov. 16, 2024, 5:25 p.m.