[BioC] More than one package document with the same name
dtenenba at fhcrc.org
Tue Aug 5 19:36:14 CEST 2014
----- Original Message -----
> From: "Julian Gehring" <julian.gehring at embl.de>
> To: bioconductor at stat.math.ethz.ch
> Sent: Tuesday, August 5, 2014 1:27:32 PM
> Subject: Re: [BioC] More than one package document with the same name
> Hi Jerry,
> Within the structure of the installed package, the vignette(s) and
> compiled manual pages live in different directories and have
> file extensions, so they can be distinguished. The changes you are
> describing are general to R packages, and would have to be enforced
> the R core.
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.
> Best wishes
> On 05.08.2014 09:25, Jerry Davison [guest] wrote:
> > Hi,
> > A suggestion. Typically a Bioconductor package provides
> > documentation of two types, one or more vignettes and a reference
> > manual; and they have the same file name, PackageName.pdf. When
> > downloaded some file name manipulation is required, or accept
> > PackageName(1).pdf.
> > I suggest the documents be given different names, for example the
> > reference manual could be named PackageNameRefMan.pdf. Package
> > checking could enforce the rule.
> Bioconductor mailing list
> Bioconductor at r-project.org
> Search the archives:
More information about the Bioconductor