insert_all_ref: Insert references cited in packages

In Rdpack: Update and Manipulate Rd Documentation Objects

Insert references cited in packages

Description

Insert references cited in packages.

Usage

insert_all_ref(refs, style = "", empty_cited = FALSE)

Arguments

refs	a matrix specifying key-package pairs of the references to insert. Can also be a cached environment, see Details.
style	a bibstyle, see Details.
empty_cited	if TRUE, empty the list of currently cited items.

Details

insert_all_ref is the workhorse behind several Rd macros for inclusion of references in Rd documentation.

Argument refs is a two-column character matrix. The first column specifies bibtex keys. To specify more than one key in a single element, separate them by commas. The second column specifies the package in which to look for the keys.

A key equal to "*" requests all keys in the corresponding package.

insert_all_ref drops duplicated keys, collects the references, and converts them to Rd textual representation for inclusion in Rd documentation files.

refs can be a cached environment. This is for internal use and not documented.

Value

a character string containing a textual representation of the references, suitable for inclusion in an Rd file

Author(s)

Georgi N. Boshnakov

References

Currently there are no citations on this help page. Nevetheless, I have put ⁠\insertAllCited{}⁠ just after this paragraph to show the message that it prints when there are no citations. This seems better than printing nothing but it may be argued also that there should be a warning as well.

\insertAllCited

Examples

## a reference from package Rdpack
cat(insert_all_ref(matrix(c("Rpack:bibtex", "Rdpack"), ncol = 2)), "\n")

## more than one reference from package Rdpack, separate the keys with commas
cat(insert_all_ref(matrix(c("parseRd,Rpack:bibtex", "Rdpack"), ncol = 2)), "\n")

## all references from package Rdpack
cat(insert_all_ref(matrix(c("*", "Rdpack"), ncol = 2)), "\n")

## all references from package Rdpack and rbibutils
m <- matrix(c("*", "Rdpack",  "*", "rbibutils"), ncol = 2, byrow = TRUE)
cat(insert_all_ref(m), "\n")

Rdpack documentation built on Nov. 8, 2023, 5:06 p.m.