[Rd] package vignettes, suggests and R CMD check

Gabor Grothendieck ggrothendieck at gmail.com
Wed Nov 22 16:20:49 CET 2006


Assuming you don't want to split it tup:

In A1 place a file A1-packages.Rd which documents all sources of documentation
for A1.  That can refers the user to the vignette in A2.
   packages?A1
will bring it up this information help file.

You could also considering having a one line vignette in A1 which just
says see the vignette in A2 and/or which provides a link which when
clicked gets it from the web.

Another possibility is to include the vignette in A2 and just the pdf
of it in A1.

On 11/21/06, Peter Ruckdeschel <Peter.Ruckdeschel at uni-bayreuth.de> wrote:
> Dear R-devels,
>
> We have encountered a problem concerning a dead lock in the dependency graph:
>
> We have two packages A1 and A2 where A2 extends A1.
>
> We have one package vignette for both packages, but which should be included
> into package A1.
>
> So in the "suggests" field of the DESCRIPTION file of A1 we suggest A2
> to be able to produce the vignette at build/install time.
>
> On the other hand this means that A2 has to be installed before being
> able to check A1, and A1, of course, has to be installed before being
> able to check A2.
>
> How can this dead lock be resolved?
>
> Is this a case for a bundle? And can a bundle have its own vignette?
>
> Thanks for listening
> Peter, Matthias, Florian, Thomas
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>



More information about the R-devel mailing list