[R] cacheSweave / pgfSweave driver for package vignette

[Romain Francois]

Le 14/08/10 19:13, baptiste auguie a écrit :
>
> Thank you everyone, I think I'll follow the technique used in Rcpp
> (dummy vignettes + Makefile).

Cool. Let us (Rcpp team) know if you find better ways or if something is 
too much trickery.

> It would be great to have a mechanism to select the driver for
> vignette generation though.
>
> Also, as a side-note, the choice of a driver has its own shortcoming;
> I cannot use the features of highlight and, say, pgfSweave in the same
> document.

It should be possible to create a new driver that combines both 
features. Let me (highlight team) know if I can do something in 
highlight to make this easier than it currently is.

Romain

> Sincerely,
>
> baptiste
>
> On 13 August 2010 11:10, Romain Francois<romain.francois at dbmail.com>  wrote:
>>
>> Hi,
>>
>> I've been meaning to ask the same question before.
>>
>> Le 13/08/10 11:01, baptiste auguie a écrit :
>>>
>>> Dear list,
>>>
>>>
>>> I wish to use a specific driver to process an sweave document in the
>>> inst/doc directory of a package. Specifically, I would like to use
>>> either cacheSweave or pgfSweave to speed up the creation of the
>>> vignette which requires lengthy computations. The same request would
>>> also apply to the highlight driver, to provide syntax highlighting of
>>> R chunks.
>>>
>>> In "writing R extensions" I see that during R CMD BUILD Sweave is run
>>> first, then optionally a makefile can be used to process any other
>>> files. It doesn't seem to leave room for a choice of Sweave engine, as
>>> far as I understand. One option I am thinking of is to change the
>>> extension of the source file to something like .Rnw2 so that Sweave
>>> ignores it altogether, and then use the appropriate command in a
>>> makefile.
>>
>> This is what we do in Rcpp to build our 7 vignettes (since we like to use
>> the driver from highlight).
>>
>> One thing to have in mind is that R needs the .Rnw file to be present in doc
>> once the package is installed, so that the vignette function works, hence
>> some trickery in Rcpp.
>>
>> A way to control which sweave (and perhaps tangle) driver is to be used for
>> a particular vignette would be very useful.
>>
>> Romain
>>
>>> I have no experience in writing makefiles, so I'm hoping someone would
>>> already have solved this issue and could provide some advice.
>>>
>>> Sincerely,
>>>
>>> baptiste

-- 
Romain Francois
Professional R Enthusiast
+33(0) 6 28 91 30 30
http://romainfrancois.blog.free.fr
|- http://bit.ly/bzoWrs : Rcpp svn revision 2000
|- http://bit.ly/b8VNE2 : Rcpp at LondonR, oct 5th
`- http://bit.ly/aAyra4 : highlight 0.2-2