Re: [R-pkg-devel] relation between vignettes and help files

2016-07-15 Thread Martin Maechler
> Duncan Murdoch > on Wed, 13 Jul 2016 16:44:41 -0400 writes: > On 13/07/2016 4:04 PM, Enrico Schumann wrote: >> On Wed, 13 Jul 2016, "Boylan, Ross" >> writes: >> >>> I have two questions, one substantive and one technical, >>> about the relation between vign

Re: [R-pkg-devel] relation between vignettes and help files

2016-07-15 Thread Boylan, Ross
One issue with integrating vignettes into the help system is that vignettes are more likely to have material (figures, math) that renders poorly or not at all as text. I also mostly use ESS on terminal rather than graphical interface, and so like the plain text version of things. OTOH, I used S

Re: [R-pkg-devel] relation between vignettes and help files

2016-07-15 Thread Kasper Daniel Hansen
Well, I think it would be a headache, and suboptimal, to require vignettes to be renderable as text. There are several issues including that not all vignettes have an included "source" file; there are packages with important vignettes which are only available as PDFs (or HTML). Also math and plot

Re: [R-pkg-devel] relation between vignettes and help files

2016-07-15 Thread Tom Wainwright
>From a user perspective, I think a distinction needs to be made between three things: help files, demos, and vignettes. I expect the help file for functions to explain the API and (briefly) the methods implemented (with references) and to have a few terse but useful examples in the Examples sectio

Re: [R-pkg-devel] relation between vignettes and help files

2016-07-15 Thread Duncan Murdoch
On 15/07/2016 8:32 AM, Martin Maechler wrote: Duncan Murdoch on Wed, 13 Jul 2016 16:44:41 -0400 writes: > On 13/07/2016 4:04 PM, Enrico Schumann wrote: >> On Wed, 13 Jul 2016, "Boylan, Ross" >> writes: >> >>> I have two questions, one substantive and one technical,

Re: [R-pkg-devel] relation between vignettes and help files

2016-07-15 Thread Duncan Murdoch
On 15/07/2016 3:02 PM, Tom Wainwright wrote: From a user perspective, I think a distinction needs to be made between three things: help files, demos, and vignettes. I expect the help file for functions to explain the API and (briefly) the methods implemented (with references) and to have a few t