citation(package = "base", lib.loc = NULL, auto = NULL)
readCitationFile(file, meta = NULL)
NULL
. The default value of NULL
corresponds to all
libraries currently known. If the default is used, the loaded
packages are searched before the libraries.NULL
(default), indicating that a
"packageDescription"
with package metadata (see
below).packageDescription
, or NULL
(the default)."bibentry"
. Execute function citation()
for information on how to cite the
base R system in publications. If the name of a non-base package is
given, the function either returns the information contained in the
In R>= 2.14.0, one can use a Authors@R field in
person
object with a refined, machine-readable
description of the package
If only one reference is given, the print method for the object
returned by citation()
shows both a text version and a BibTeX
entry for it, if a package has more than one reference then only the
text versions are shown. The BibTeX versions can be obtained using
function toBibtex()
(see the examples below).
The readCitationFile()
is
used by citation()
to extract the information in
source()
ed by the R
parser in a temporary environment and all resulting bibliographic
objects (specifically, of class "bibentry"
) are
collected.
Traditionally, the citHeader
, then one or more calls to citEntry
,
and finally zero or more calls to citFooter
, where in fact
citHeader
and citFooter
are simply wrappers to
paste
, with their ...
argument passed on to
paste
as is. The "bibentry"
class
makes for improved representation and manipulation of bibliographic
information (in fact, the old mechanism is implemented using the new
one), and one can write bibentry
interface.
One can include an auto-generated package citation in the
citation(auto = meta)
.
readCitationFile
makes use of the Encoding
element (if
any) of meta
to determine the encoding of the file.
bibentry
## the basic R reference
citation()
## references for a package -- might not have these installed
if(nchar(system.file(package = "lattice"))) citation("lattice")
if(nchar(system.file(package = "foreign"))) citation("foreign")
## extract the bibtex entry from the return value
x <- citation()
toBibtex(x)
Run the code above in your browser using DataCamp Workspace