Re: tasks overview wishlist: Canonical citing reference
On 11 October 2008 at 15:40, Chris Walker wrote:
| I do like the approach of having a simple plain text file - while not
| machine readable does make it clear the appropriate citation - (and in
FWIW that is was R does. For the subset of CRAN package I maintain, here is
the subset having such a file:
edd@ron:~> find src/debian/CRAN/ -name CITATION
src/debian/CRAN/sn-0.4-6/inst/CITATION
src/debian/CRAN/tseries-0.10-16/inst/CITATION
src/debian/CRAN/urca-1.1-7/inst/CITATION
src/debian/CRAN/date-1.2.26/inst/CITATION
src/debian/CRAN/strucchange-1.3-4/inst/CITATION
src/debian/CRAN/chron-2.3-24/inst/CITATION
src/debian/CRAN/sm-2.2-3/inst/CITATION
src/debian/CRAN/VR-7.2.44/class/inst/CITATION
src/debian/CRAN/VR-7.2.44/nnet/inst/CITATION
src/debian/CRAN/VR-7.2.44/spatial/inst/CITATION
src/debian/CRAN/VR-7.2.44/MASS/inst/CITATION
src/debian/CRAN/zoo-1.5-4/inst/CITATION
src/debian/CRAN/sandwich-2.1-0/inst/CITATION
src/debian/CRAN/nlme-3.1.89/inst/CITATION
src/debian/CRAN/multcomp-1.0-2/inst/CITATION
src/debian/CRAN/boot-1.2.34/inst/CITATION
src/debian/CRAN/cluster-1.11.11/inst/CITATION
src/debian/CRAN/lmtest-0.9.21/inst/CITATION
src/debian/CRAN/mgcv-1.4-1/inst/CITATION
Content of the inst/ directory will always appear in the top-level directory
of the installed package. The per-package summary then points out that a
citation file exists, and the citation() function can use. E.g. for the sn
package that happens to be first in the list above (and two lines indented by me)
-----------------------------------------------------------------------------
edd@ron:~> r -lsn -e'print(citation("sn"))'
Package 'sn', 0.4-4 (2007-10-08). Type 'help(SN)' for summary information
To cite the sn package in publications use:
Azzalini, A. (2007). R package 'sn': The skew-normal and skew-t
distributions (version 0.4-4). URL http://azzalini.stat.unipd.it/SN
A BibTeX entry for LaTeX users is
@manual{,
title = {{R} package \texttt{sn}:The skew-normal and skew-$t$
distributions (version 0.4-4)},
author = {A. Azzalini},
address = {Universit\`a di Padova, Italia},
year = {2007},
url = {URL http://azzalini.stat.unipd.it/SN},
}
edd@ron:~>
-----------------------------------------------------------------------------
R itself provides its citation via the default (ie empty) argument:
-----------------------------------------------------------------------------
edd@ron:~> r -e'print(citation();
To cite R in publications use:
R Development Core Team (2008). R: A language and environment for
statistical computing. R Foundation for Statistical Computing, Vienna,
Austria. ISBN 3-900051-07-0, URL http://www.R-project.org.
A BibTeX entry for LaTeX users is
@Manual{,
title = {R: A Language and Environment for Statistical Computing},
author = {{R Development Core Team}},
organization = {R Foundation for Statistical Computing},
address = {Vienna, Austria},
year = {2008},
note = {{ISBN} 3-900051-07-0},
url = {http://www.R-project.org},
}
We have invested a lot of time and effort in creating R, please cite it when
using it for data analysis. See also citation("pkgname") for citing R
packages.
-----------------------------------------------------------------------------
Obviously, this is easier for R as it provides one coherent system. But we
could start with an additional file in debian/ and go from there.
Dirk
--
Three out of two people have difficulties with fractions.
Reply to: