insert_citeOnly: Generate citations from bibtex keys

View source: R/bib.R

insert_citeOnlyR Documentation

Generate citations from bibtex keys

Description

Generate citations from bibtex keys.

Usage

insert_citeOnly(keys, package = NULL, before = NULL, after = NULL,
                bibpunct = NULL, ..., cached_env = NULL,
                cite_only = FALSE, dont_cite = FALSE)

Arguments

keys

a character string containing bibtex key(s) prefixed with the symbol @, intermixed with free text. The format is the same as for Rd macro ⁠\insertCite⁠. Put ⁠;textual⁠ at the end of the string to get a textual citation. Similarly, ⁠;nobrackets⁠ requests parenthesised citation without the enclosing parentheses. Alternatively, keys can contain one or more keys, separated by commas.

package

name of an R package.

before

see citeNatbib.

after

see citeNatbib.

bibpunct

see citeNatbib.

...

further arguments; for internal use.

cached_env

for internal use.

cite_only

for internal use.

dont_cite

for internal use.

Details

This is the function behind ⁠\insertCite⁠ and related macros. Argument "keys" has the syntax of the first argument of ⁠\insertCite⁠, see insertRef for full details.

Value

a character vector containing the references with Rd markup

Author(s)

Georgi N. Boshnakov

See Also

insert_ref for description of all available Rd macros

Examples

insert_citeOnly("@see also @Rpackage:rbibutils and @parseRd", package = "Rdpack")
## (see also Boshnakov and Putman 2020 and Murdoch 2010)

insert_citeOnly("@see also @Rpackage:rbibutils and @parseRd;nobrackets",
  package = "Rdpack")
## see also Boshnakov and Putman 2020 and Murdoch 2010

insert_citeOnly("@see also @Rpackage:rbibutils and @parseRd;textual",
  package = "Rdpack")
## see also Boshnakov and Putman (2020) and Murdoch (2010)

GeoBosh/Rdpack documentation built on Nov. 11, 2023, 5:22 p.m.