From ggrothendieck at gmail.com  Thu Jan 15 16:10:23 2009
From: ggrothendieck at gmail.com (Gabor Grothendieck)
Date: Thu, 15 Jan 2009 10:10:23 -0500
Subject: [Rd] Documentation suggestions for vignettes
In-Reply-To: <EFB51359-7BF0-456B-AAEE-9AA9E401237E@berkeley.edu>
References: <EFB51359-7BF0-456B-AAEE-9AA9E401237E@berkeley.edu>
Message-ID: <971536df0901150710o4b6a19dapc8f62b596491ede3@mail.gmail.com>

On Wed, Jan 14, 2009 at 2:53 PM, Perry de Valpine
<pdevalpine at berkeley.edu> wrote:
> Dear R-devel,
>
> I am putting together a package vignette for the first time (R 2.8.1,
> OS X) and had some bumps from section 1.4 ("Writing package
> vignettes") of the "Writing R Extensions" document.  Here are
> suggestions to clean up a few small documentation bugs (I think) and
> omissions.  This is assuming that R is performing as intended and the
> only gaps are in the documentation, not vice-versa.
>
> The statement "Pointers from package help indices to the installed
> documents are automatically created" made me think I could put a pdf
> in inst/doc and it would automatically be treated as a vignette. When
> I did R CMD BUILD and R CMD INSTALL, an index.html was created in
> inst/doc (and my pdf was copied there) but it stated there are no
> vignettes for this package, and R indeed could not find the vignette.
> How about stating that index.html is needed and sticking in an example?
> I eventually figured it out by looking at the grid package source.

Could you please clarify this comment.  I could not find an index.html file
in the grid package source (R revision 47606 synced today):

C:\\R\src\library\grid>dir/s index.html
File Not Found



[Rd] Documentation suggestions for vignettes
Gabor Grothendieck