From bbo|ker @end|ng |rom gm@||@com  Sun Nov  1 20:35:55 2020
From: bbo|ker @end|ng |rom gm@||@com (Ben Bolker)
Date: Sun, 1 Nov 2020 14:35:55 -0500
Subject: [Rd] vignettes present in 2 folders or won't work
In-Reply-To: <6c01a1ec-9846-e906-d46f-1175c866c4f1@gmail.com>
References: <CAERMt4eKagsBYjGRbJOJugWgB03b0QeenJMSdRwbXcy0qqxCMA@mail.gmail.com>
 <aed3b504-93f0-fc77-3bc3-5c7b7286286b@gmail.com>
 <CAERMt4eknfdoHjgxN9gCbHeQ=odtO_YargCWNK=Ntsuv5HbyhQ@mail.gmail.com>
 <6c01a1ec-9846-e906-d46f-1175c866c4f1@gmail.com>
Message-ID: <18624aa0-215e-3afe-28bd-d450a3bae725@gmail.com>

   I take Duncan's point but would second the motion to have WRE clarify 
how static vignettes are supposed to work; it's a topic I am repeatedly 
confused about despite being an experienced package maintainer. If 
knowledgeable outsiders compiled a documentation patch would it be 
likely to be considered ...??

On 11/1/20 2:29 PM, Duncan Murdoch wrote:
> On 01/11/2020 1:02 p.m., Alexandre Courtiol wrote:
>> Noted Duncan and TRUE...
>>
>> I cannot do more immediately unfortunately, that is always the issue 
>> of asking a last minute panic attack question before teaching a course 
>> involving the package...
>> I do have /doc in my .Rbuildignore for reasons I can no longer 
>> remember... I will dig and create a MRE/reprex.
>> The students will download heavy packages, but they probably won't 
>> notice.
>> *Apologies*
>>
>> In the meantime, perhaps my question was clear enough to get clarity on:
>> 1) whether having vignettes twice in foders inst/doc and vignettes is 
>> normal or not when vignettes are static.
>> 2) where could anyone find a complete documentation on R vignettes 
>> since it is a recurring issue in this list and elsewhere.
> 
> The Writing R Extensions manual describes vignette support in R, but R 
> allows contributed packages (like knitr, rmarkdown, R.rsp) to handle 
> vignettes.? WRE explains enough to write such a package, but it's up to 
> their authors to document how to use them, so "complete documentation" 
> is spread out all over the place.? As with any documentation, there are 
> probably errors and omissions.
> 
> Duncan Murdoch
> 
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel



[Rd] vignettes present in 2 folders or won't work
Ben Bolker