Creates character strings to cite R and R packages.
cite_r(
file = NULL,
prefix = "R-",
footnote = FALSE,
pkgs = NULL,
omit = TRUE,
...
)
If footnote = FALSE
a character string is returned, otherwise a
named list with the elements r
and pkgs
.
Character. Path and name of the .bib
-file holding the
references. If NULL
, only R is cited.
Character. Prefix used for all R-package reference handles.
Logical. Indicates if packages should be cited in a footnote. Ignored if no package information is available.
Character. Vector of package names to cite or omit depending
on omit
.
Logical. If TRUE
, pkgs
constitutes a list of packages
not to cite (a blacklist). If FALSE
, pkgs
constitutes a list of
packages to cite (a whitelist).
Additional arguments, which are currently ignored.
If footnote = FALSE
, a character string citing R and R packages
including version numbers is returned. Otherwise a named list with the
elements r
and pkgs
is returned. The former element holds a character
string citing R and a reference to a footnote; the latter element contains
a character string that creates the footnote. For correct rendering, the
footnote string needs to be a separate paragraph in the R Markdown
document.
r_refs()
, knitr::write_bib()