[R] cite publications in the package help file

[Duncan Murdoch]

On 28/04/2015 2:28 PM, carol white wrote:
> the main web page is meant the page when a package is accessed on CRAN.
> So is it possible on this page that the content of DESCRIPTION is
> displayed to display the related publications and also put the related
> publications so that they appear on the help pdf file?

That page is produced by CRAN.  The text at the top is the
"Description:" field from your DESCRIPTION file, so you could put text
about other publications there, but it needs to be just one paragraph,
so a reference list wouldn't be appropriate.  Adding a sentence like
"See the 'foo' vignette for related references." seems reasonable.
(Or you  could refer to the reference manual, or a help page, etc.)

Duncan Murdoch

> 
> 
> 
> On Tuesday, April 28, 2015 7:37 PM, Duncan Murdoch
> <murdoch.duncan at gmail.com> wrote:
> 
> 
> On 28/04/2015 1:00 PM, carol white via R-help wrote:
> 
>> To cite related publications, it seems that they can't be mentioned
> in  DESCRIPTION. Where to mention so that it appears on the 1st page of 
> the pdf help file and the package main web page? I'm not talking about
> what is specified in  inst/citation.
> 
> 
> The package help file (e.g. foo-package.Rd for package "foo") will be
> displayed first in the PDF, and is the first entry linked in the help
> page index for the package.
> 
> I don't know what page you mean as the "package main web page".
> 
> Duncan Murdoch
> 
> 
>