From ligges at statistik.tu-dortmund.de  Thu Apr 12 09:48:05 2012
From: ligges at statistik.tu-dortmund.de (Uwe Ligges)
Date: Thu, 12 Apr 2012 09:48:05 +0200
Subject: [Rd] Vignette questions
In-Reply-To: <A26E51EB75D20B4DAC8AEA2A883BF3997B50587DA5@uranus.ipht-jena.de>
References: <4F85EC88.8070604@mayo.edu>,
	<CANROs4c7b5ThXTXRXt1BARYF1O3SG2s39X3iQEXHAVvjZQttaQ@mail.gmail.com>
	<A26E51EB75D20B4DAC8AEA2A883BF3997B50587DA5@uranus.ipht-jena.de>
Message-ID: <4F8688B5.1010901@statistik.tu-dortmund.de>



On 12.04.2012 00:23, beleites,claudia wrote:
> Very quick&  short answer:
>
> I made the transition to  ./vignettes for hyperSpec (you can look at the source at r-forge) - it was a mess. It is almost working now (compression is missing, I'll have to figure out how to invoke ghostscript in an OS idependent way, qpdf doesn't give me the compression rates).


R CMD build --compact-vignettes=gs

Uwe



>
> I have .pdf is under version control only for those vignettes that I build externally (with the fake .Rnws that produce the proper indexing as vignette).  They are all (regardless whether BUILD and check affect them or not) in ./vignettes.
> I think that strategy can at least partially solve the issue with non-Sweave vignettes as well as long as the result is a pdf.
> You may need to play with ./vignettes/.install_extras if additional, non pdf and non Rnw files are needed.
>
>
> Best,
>
> Claudia
>
>
> ________________________________________
> Von: r-devel-bounces at r-project.org [r-devel-bounces at r-project.org] im Auftrag von Yihui Xie [xie at yihui.name]
> Gesendet: Mittwoch, 11. April 2012 23:28
> An: Terry Therneau
> Cc: r-devel at r-project.org
> Betreff: Re: [Rd] Vignette questions
>
> For 1, you should run R CMD check on the tar ball (pkg_x.x.tar.gz)
> from R CMD build instead of the source directory. R CMD build will
> build the PDF vignette into the tar ball.
>
> For 2, I have been confused by ./vignettes vs ./inst/doc since
> ./vignettes was introduced. I might be able to figure it out by
> try-and-err but I never tried, and I'm still sticking to ./inst/doc.
> At least you can exclude the Rnw source in .Rbuildignore so that R can
> only stare at your PDF documents and sigh.
>
> For 3, I remember some of us requested that R could also respect
> entries of non-Sweave vignettes (like the ones in ./demo/00Index), but
> this is not possible as far as I know. However, I can tell you a dark
> voodoo seems to be still working: you can write your own index.html
> under ./inst/doc with your own links to vignettes.
>
> Regards,
> Yihui
> --
> Yihui Xie<xieyihui at gmail.com>
> Phone: 515-294-2465 Web: http://yihui.name
> Department of Statistics, Iowa State University
> 2215 Snedecor Hall, Ames, IA
>
>
>
> On Wed, Apr 11, 2012 at 3:41 PM, Terry Therneau<therneau at mayo.edu>  wrote:
>> Context: R2.15-0 on Ubuntu.
>>
>> 1. I get a WARNING from CMD check for "Package vignette(s) without
>> corresponding PDF:
>>   In this case the vignettes directory had both the pdf and Rnw; do I need to
>> move the pdf to inst/doc?
>>
>>    I'm reluctant to add the pdf to the svn source on Rforge, per the usual
>> rule that a code management system should not have both a primary source and
>> a object dervived from it under version control.  However, if this is the
>> suggested norm I could do so.
>>
>> 2. Close reading of the paragraph about vignette sources shows the following
>> -- I think?  If I have a vignette that should not be rebuilt by "check" or
>> "BUILD" I should put the .Rnw source and pdf in /inst/doc, and have the
>> others that should be rebuilt in /vignettes.  This would include any that
>> use "private R packages, screen snapshots, ...", or in my case one that
>> takes just a little short of forever to run.
>>
>> 3. Do these unprocessed package also contribute to the index via
>> \VignetteIndexEntry lines, or will I need to create a custom index?
>>
>> Terry Therneau
>>
>> ______________________________________________
>> R-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel



[Rd] Vignette questions
Uwe Ligges