[R] R CMD build and vignettes

Enrico Schumann enricoschumann at yahoo.de
Wed Sep 21 13:45:26 CEST 2011

There are various options, and it depends on your work flow and the 
people that you expect to use the code. If they get a working copy of 
the directory (with only the Rnw-files*) and then build/install the 
package, they get the pdfs; so you do not need to add the pdfs. (If they 
don't build the package, you could also distribute the tarball.)

You can also build the vignettes through 'Sweave' (in the utils package; 
or use 'R CMD Sweave'). Or, after you ran 'R CMD check', go to the 
'<pkg>.Rcheck' directory it created: there you will also find the pdfs 
(under /<pkg>/doc). Or simply extract the pdfs from the *.tar.gz.

As I said, it depends on your work flow and the work flow of your 
coworkers. If you need to provide the pdfs, you can decide on one way 
and then write some batch-file that automates the procedure.


* and other required files like bib-files

Am 21.09.2011 12:38, schrieb Ashim Kapoor:
> Dear Enrico,
> Many thanks for your reply.I was doing R CMD check pkg ( where pkg is the
> directory name and NOT the tar ball  ). May I ask another query or should
> this goto R-devel ? Once I do a R CMD build the vignette PDF's are inside
> the tar ball ,how will I put the PDF for the vignette in the pkg/inst/doc/
> of my svn folder so I can commit it and other people can see no bugs when
> the check the directory.  Perhaps I am misunderstanding something much more
> basic.
> Best Regards,
> Ashim
> On Wed, Sep 21, 2011 at 3:53 PM, Enrico Schumann<enricoschumann at yahoo.de>wrote:
>> Hi Ashim,
>> after 'R CMD build' the vignettes are in the<pkg>*.tar.gz file, not in
>> your package directory. So if you run 'R CMD build<pkg>' and then 'R CMD
>> check<pkg>*.tar.gz', you should not get that warning.
>> For such questions you may get better answers on R-devel; see, eg,  this
>> thread here
>> https://stat.ethz.ch/**pipermail/r-devel/2011-May/**060775.html<https://stat.ethz.ch/pipermail/r-devel/2011-May/060775.html>
>> Regards,
>> Enrico
>> Am 21.09.2011 11:01, schrieb Ashim Kapoor:
>>> Dear R-helpers,
>>> www.statistik.lmu.de/~*leisch***/*Sweave*/*Sweave*-Rnews-2003-**2.pdf<http://www.statistik.lmu.de/%7E*leisch*/*Sweave*/*Sweave*-Rnews-2003-2.pdf>
>>> says that  R CMD build creates the pdf from a .Rnw file. But when I do R
>>> CMD
>>> build followed by R CMD check it gives me a warning that there is a
>>> vignette
>>> without a PDF. My query is : when
>>> R CMD build works it creates a pdf in the doc subdirectory of the
>>> directory
>>> returned by system.file(package = mypackage) and not in the inst/doc
>>> directory of the package that we are creating. Do we have to Sweave and
>>> create the pdf in the inst/doc subdirectory on our own ? Please clarify.
>>> Regards,
>>> Ashim
>>>         [[alternative HTML version deleted]]
>>> ______________________________**________________
>>> R-help at r-project.org mailing list
>>> https://stat.ethz.ch/mailman/**listinfo/r-help<https://stat.ethz.ch/mailman/listinfo/r-help>
>>> PLEASE do read the posting guide http://www.R-project.org/**
>>> posting-guide.html<http://www.R-project.org/posting-guide.html>
>>> and provide commented, minimal, self-contained, reproducible code.
>> --
>> Enrico Schumann
>> Lucerne, Switzerland
>> http://nmof.net/

Enrico Schumann
Lucerne, Switzerland

More information about the R-help mailing list