Cite a collection of R packages — pkrt

Creates a list of package citations that can be turned into a character string or data frame. This function should normally only be used in an R Markdown or Quarto document, in which case pkrt_list() automatically references the cited packages in the first (by default) .bib file specified in the YAML header if no references of the packages already exist.

Usage

pkrt_list(...)

Arguments

...: Character vectors, separated by commas, of packages to cite.

Value

A list of package citations with S3 class pkrt_list.

Details

This function automatically discards duplicate and base packages. You can use pkrt_list() in combination with renv::dependencies() to cite all the packages used in a project or directory.

Examples

# Create a list of citations
citations <- pkrt_list("pakret", "readr", "knitr")

# You can then turn the citations into a character string
paste(citations, collapse = ", ")
#> [1] "'pakret' v. 0.3.0 [@pakret], 'readr' v. 2.1.6 [@readr], 'knitr' v. 1.50 [@knitr]"

# Or a data frame
as.data.frame(citations)
#>   Package Version Reference
#> 1   knitr    1.50    @knitr
#> 2  pakret   0.3.0   @pakret
#> 3   readr   2.1.6    @readr