get_citations {grateful}

Get citations for packages

Description

Get citations for packages

Usage

get_citations(
  pkgs = NULL,
  out.dir = NULL,
  bib.file = "grateful-refs",
  include.RStudio = FALSE
)

Arguments

pkgs

Character vector of package names, e.g. obtained by scan_packages().

out.dir

Directory to save the output document and a BibTeX file with the references. It is recommended to set out.dir = getwd().

bib.file

Desired name for the BibTeX file containing packages references ("grateful-refs" by default).

include.RStudio

Logical. If TRUE, adds a citation for the current version of RStudio.

Value

A file on the specified out.dir containing the package references in BibTeX format. If assigned a name, get_citations will also return a list with citation keys for each citation (without @).

Examples

citekeys <- get_citations(c("knitr", "renv"), out.dir = tempdir())

pkgs <- scan_packages()
citekeys <- get_citations(pkgs$pkg, out.dir = tempdir())