add_pkg_to_bib: Add Package Citations to BibTeX File

View source: R/add_pkg_to_bib.R

add_pkg_to_bibR Documentation

Add Package Citations to BibTeX File

Description

Adds citation information for R packages to a BibTeX file. Uses the knitr::write_bib function to generate and append package citations in BibTeX format.

Usage

add_pkg_to_bib(pkg_name, bib_file = "packages.bib")

Arguments

pkg_name

Character string. The name of the R package to add to the BibTeX file.

bib_file

Character string. The path and name of the BibTeX file to write to. Default is "packages.bib".

Details

The function will create the BibTeX file if it doesn't exist, or append to it if it does. It includes citations for both the specified package and all currently loaded packages.

Value

Invisible NULL. The function is called for its side effect of writing to the BibTeX file.

Examples

# Create a temporary BibTeX file
my_bib_file <- tempfile(fileext = ".bib")

# Add citations for dplyr package
add_pkg_to_bib("dplyr", my_bib_file)

# View the contents of the BibTeX file
readLines(my_bib_file) |> cat(sep = "\n")


qtkit documentation built on April 4, 2025, 4:47 a.m.