[Bioc-devel] [BioC] More than one package document with the same name

[Michael Love]

(copying over to bioc-devel). I do appreciate the very few keystrokes
it takes to do, e.g.

vignette('affy')

of course I can find them all with browseVignettes('affy') and
sometimes the above is not the right name, but I like that the primary
documentation is so close at hand. this is slightly more of a pain:

vignette('affy-vignette')

On Tue, Aug 5, 2014 at 2:03 PM, Julian Gehring <julian.gehring at embl.de> wrote:
> Hi,
>
> For the BiocCheck of the vignette name, one could also check that the
> vignette file name is not 'package.[Rnw|Rmd]'.  This would give more
> flexibility, and avoid a fixed naming scheme.
>
> Since the issue affects all R packages - bioc or not -, I still think it is
> worth trying to address this at the R level.
>
> Best wishes
> Julian
>
>
>
> On 05.08.2014 10:36, Dan Tenenbaum wrote:
>>
>>
>> I'm not sure this is true. The vignette can be named whatever the package
>> author wants, as long as it has the appropriate file extension.
>> So BiocCheck could suggest that it be named package-vignette.Rnw instead
>> of package.Rnw.
>> And the compiled (PDF) reference manual doesn't exist in a source package.
>> So (this is probably better than my previous suggestion) BioC could rename
>> the compiled manuals on the package landing pages to be (e.g.)
>> package-manual.pdf instead of package.pdf.
>>
>> Dan
>>
>
> _______________________________________________
> Bioconductor mailing list
> Bioconductor at r-project.org
> https://stat.ethz.ch/mailman/listinfo/bioconductor
> Search the archives:
> http://news.gmane.org/gmane.science.biology.informatics.conductor