pkg_bib | R Documentation |
Call utils::citation()
and utils::toBibtex()
to create bib entries for R
packages and write them in a file. It can facilitate the auto-generation of
bibliography databases for R packages, and it is easy to regenerate all the
citations after updating R packages.
pkg_bib(
x = .packages(),
file = "",
tweak = TRUE,
width = NULL,
prefix = getOption("xfun.bib.prefix", "R-"),
lib.loc = NULL,
packageURL = TRUE,
date = c("none", "package", "today")
)
x |
Package names. Packages which are not installed are ignored. |
file |
The (‘.bib’) file to write. By default, or if |
tweak |
Whether to fix some known problems in the citations, especially non-standard format of author names. |
width |
Width of lines in bibliography entries. If |
prefix |
Prefix string for keys in BibTeX entries; by default, it is
|
lib.loc |
A vector of path names of R libraries. |
packageURL |
Use the |
date |
The way to include a date of the form |
For a package, the keyword R-pkgname
is used for its bib item, where
pkgname
is the name of the package. Citation entries specified in the
‘CITATION’ file of the package are also included. The main purpose of
this function is to automate the generation of the package citation
information because it often changes (e.g., the author, year, package
version, and so on).
There are at least two different uses for the URL in a reference list. You
might want to tell users where to go for more information. In that case, use
the default packageURL = TRUE
, and the first URL listed in the
‘DESCRIPTION’ file will be used. Be careful: some authors don't put the
most relevant URL first. Alternatively, you might want to identify exactly
which version of the package was used in the document. If it was installed
from CRAN or some other repositories, the version number identifies it, and
packageURL = FALSE
will use the repository URL (as used by
utils::citation()
).
A list containing the citations. Citations are also written to the
file
as a side effect.
Some packages on CRAN do not have standard bib entries, which was once
reported by Michael Friendly at
https://stat.ethz.ch/pipermail/r-devel/2010-November/058977.html. I
find this a pain, and there are no easy solutions except contacting package
authors to modify their DESCRIPTION files. The argument tweak
has
provided hacks to deal with known packages with non-standard bib entries;
tweak = TRUE
is by no means intended to hide or modify the original
citation information. It is just due to the loose requirements on package
authors for the DESCRIPTION file. On one hand, I apologize if it really
mangles the information about certain packages; on the other, I strongly
recommend package authors to consider the Authors@R
field (see the
manual Writing R Extensions) to make it easier for other people to cite R
packages.
Yihui Xie and Michael Friendly
pkg_bib(c("base", "MASS", "xfun"))
pkg_bib("cluster", prefix = "R-pkg-") # a different prefix
pkg_bib("xfun", date = "package")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.