Skip to content

BibTeX entries in CITATION file

6 messages · Duncan Murdoch, Mauricio Zambrano-Bigiarini, Achim Zeileis

#
Dear List,

While trying to define a customised CITATION file for a package, 
following R-exts, I realised that if I use only one 'citEntry' I got 
both a text description and a BibTex entry for the package, as for the 
'nlme' package:

--------------------------
citation('nlme')

To cite package 'nlme' in publications use:

   Jose Pinheiro, Douglas Bates, Saikat DebRoy, Deepayan Sarkar and the
   R Development Core Team (2012). nlme: Linear and Nonlinear Mixed
   Effects Models. R package version 3.1-105.

A BibTeX entry for LaTeX users is

   @Manual{,
     title = {nlme: Linear and Nonlinear Mixed Effects Models},
     author = {Jose Pinheiro and Douglas Bates and Saikat DebRoy and 
Deepayan Sarkar and {R Core Team}},
     year = {2012},
     note = {R package version 3.1-105},
   }

-----------------------------------


BUT, if I use two or more 'citEntry' in the CITATION file (e.g., for the 
manual and a book), the bibTeX entries are NOT shown any more, and only 
the text description for the two or more entries are shown, as for the 
'boot' package:

-----------------------------------
citation('boot')

To cite the 'boot' package in publications use:

   Angelo Canty and Brian Ripley (2012). boot: Bootstrap R (S-Plus)
   Functions. R package version 1.3-7.

   Davison, A. C. & Hinkley, D. V. (1997) Bootstrap Methods and Their
   Applications. Cambridge University Press, Cambridge. ISBN
   0-521-57391-2
-----------------------------------

Is there any way to show the two bib entries for cases similar to the 
'boot' package ?


sessionInfo()
R version 2.15.2 (2012-10-26)
Platform: x86_64-redhat-linux-gnu (64-bit)

locale:
  [1] LC_CTYPE=en_GB.utf8       LC_NUMERIC=C
  [3] LC_TIME=en_GB.utf8        LC_COLLATE=en_GB.utf8
  [5] LC_MONETARY=en_GB.utf8    LC_MESSAGES=en_GB.utf8
  [7] LC_PAPER=C                LC_NAME=C
  [9] LC_ADDRESS=C              LC_TELEPHONE=C
[11] LC_MEASUREMENT=en_GB.utf8 LC_IDENTIFICATION=C

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base



Thanks in advance,

Mauricio Zambrano-Bigiarini
#
On Thu, 22 Nov 2012, Mauricio Zambrano-Bigiarini wrote:

            
toBibtex(citation("boot"))

extracts the two BibTeX entries.

See also

Kurt Hornik, Duncan Murdoch, Achim Zeileis (2012).
Who Did What? The Roles of R Package Authors and How to Refer to Them.
The R Journal, 4(1), 64-69.
http://journal.r-project.org/archive/2012-1/RJournal_2012-1_Hornik~et~al.pdf

for more details and discussion about the underlying ideas.

Best,
Z
#
On 22/11/2012 11:28 AM, Mauricio Zambrano-Bigiarini wrote:
toBibtex(citation("boot"))

should do it.
#
On 22/11/12 17:36, Duncan Murdoch wrote:
Thank you very much Achim and Duncan.

However, I was not clear enough. My question is if there is any way in 
which I should modify the CITATION file of my package in order to show 
the two or more bib entries automatically. For example, when you type:

citation("boot")

my expected output is something like:

------------
To cite the 'boot' package in publications use:

  Angelo Canty and Brian Ripley (2012). boot: Bootstrap R (S-Plus)
  Functions. R package version 1.3-7.

  Davison, A. C. & Hinkley, D. V. (1997) Bootstrap Methods and Their
  Applications. Cambridge University Press, Cambridge. ISBN
  0-521-57391-2

  BibTeX entries for for LaTeX users are:

....
....

----------------

Is there any way in which I can achieve this ?


Mauricio
#
On Thu, 22 Nov 2012, Mauricio Zambrano-Bigiarini wrote:

            
No, this is currently not possible. format.bibentry() always omits the 
BibTeX if there are 2 or more entries (in style = "citation").

The CRAN web page for the package always displays all BibTeX entries 
though: http://CRAN.R-project.org/web/packages/boot/citation.html
#
On 22/11/12 18:23, Achim Zeileis wrote:
Thanks !

All the best,

Mauricio