pkgmaker (version 0.32.2)

write.pkgbib: Generate a Bibtex File from Package Citations

Description

Generates a Bibtex file from a list of packages or all the installed packages. It is useful for adding relevant citations in Sweave documents.

Usage

write.pkgbib(
  entry = NULL,
  file = "Rpackages.bib",
  prefix = "",
  append = FALSE,
  verbose = TRUE
)

Arguments

entry

a bibentry object or a character vector of package names. If NULL, then the list of all installed packages is used.

file

output Bibtex file. It can be specified as a filename (as a single character string), NULL for stdout, or a link{connection} object. If file is a character string, an extension '.bib' is appended if not already present.

prefix

character string to prepend to the generated packages' Bibtex key.

append

a logical that indicates that the Bibtex entries should be added to the file. If FALSE (default), the file is overwritten.

verbose

a logical to toggle verbosity. If file=NULL, verbosity is forced off.

Value

the list of Bibtex objects -- invisibly.

Details

Multiple citations are handled by adding a numeric suffix to the Bibtex key (other than the first/main citation) as "<pkgname>%i" (e.g. pkg, pkg2, pkg3).

References

Creating bibtex file of all installed packages? Achim Zeileis. R-help mailing list. https://stat.ethz.ch/pipermail/r-help/2009-December/415181.html

See Also

link{connection}, link{bibentry}

Examples

# NOT RUN {
write.pkgbib(c('rbibutils', 'utils', 'tools'), file='references')
bibs <- rbibutils::readBib('references.bib', "UTF-8")
write.pkgbib(bibs, 'references2.bib')
bibs2 <- rbibutils::readBib('references.bib', "UTF-8")
identical(bibs, bibs2)
# }
# NOT RUN {
# write to stdout()
write.pkgbib(c('rbibutils', 'utils', 'tools'), file=NULL)

# clean up 
unlink(c('references.bib', 'references2.bib'))

# }