| Line 43... |
Line 43... |
| 43 |
The \R core development team and the very active community of package
|
43 |
The \R core development team and the very active community of package
|
| 44 |
authors have invested a lot of time and effort in creating \R as it is
|
44 |
authors have invested a lot of time and effort in creating \R as it is
|
| 45 |
today. Please give credit where credit is due and cite \R and \R
|
45 |
today. Please give credit where credit is due and cite \R and \R
|
| 46 |
packages when you use them for data analysis.
|
46 |
packages when you use them for data analysis.
|
| 47 |
|
47 |
|
| 48 |
Execute function \code{citation()} for information on how to cite the
|
48 |
Use \code{citation()} (without arguments) for information on how to
|
| 49 |
base R system in publications. If the name of a non-base package is
|
49 |
cite the base R system in publications.
|
| 50 |
given, as controlled by the \code{auto} argument, the function either
|
- |
|
| 51 |
returns the information contained in the \file{CITATION} file of the
|
- |
|
| 52 |
package (using \code{readCitationFile} with \code{meta} equal to
|
- |
|
| 53 |
\code{packageDescription(package, lib.loc)}) or auto-generates
|
- |
|
| 54 |
citation information from the \file{DESCRIPTION} file. For CRAN and
|
- |
|
| 55 |
Bioconductor packages, auto-generating automatically adds package
|
- |
|
| 56 |
\abbr{URL}s and \abbr{DOI}s.
|
- |
|
| 57 |
|
50 |
|
| - |
|
51 |
If \code{citation()} is called with \code{package} the name of a
|
| - |
|
52 |
non-base package, as controlled by the \code{auto} argument it either
|
| - |
|
53 |
returns the information contained in the package \file{CITATION} file
|
| - |
|
54 |
or auto-generates citation information from the package
|
| - |
|
55 |
\file{DESCRIPTION} file. By default (\code{auto = NULL}), the
|
| - |
|
56 |
\file{CITATION} file is used if it exists, in which case it is read
|
| - |
|
57 |
via \code{readCitationFile} with \code{meta} equal to
|
| - |
|
58 |
\code{packageDescription(package, lib.loc)}. One can force
|
| - |
|
59 |
auto-generation via \code{auto = TRUE}.
|
| - |
|
60 |
|
| - |
|
61 |
The auto-generated citation includes \abbr{URL}s for packages
|
| - |
|
62 |
installed from the standard repositories CRAN and Bioconductor and
|
| - |
|
63 |
from development platforms such as \I{GitHub}, \I{GitLab}, or
|
| - |
|
64 |
\I{R-Forge}. In case of CRAN and Bioconductor, \abbr{DOI}s are
|
| - |
|
65 |
included as well.
|
| - |
|
66 |
|
| 58 |
Packages can use an \samp{Authors@R} field in their
|
67 |
Packages can use an \samp{Authors@R} field in their
|
| 59 |
\file{DESCRIPTION} to provide (\R code giving) a
|
68 |
\file{DESCRIPTION} to provide (\R code giving) a
|
| 60 |
\code{\link{person}} object with a refined, machine-readable
|
69 |
\code{\link{person}} object with a refined, machine-readable
|
| 61 |
description of the package \dQuote{authors} (in particular specifying
|
70 |
description of the package \dQuote{authors} (in particular specifying
|
| 62 |
their precise roles). Only those with an author role will be
|
71 |
their precise roles). Only those with an author role will be
|
The R Project SVN
R