f info
between help files and
> vignettes?
> Ross
>
> From: Martin Maechler [maech...@stat.math.ethz.ch]
> Sent: Friday, July 15, 2016 5:32 AM
> To: Duncan Murdoch
> Cc: Enrico Schumann; Boylan, Ross; r-package-devel@r-project.org
> Subject:
oylan, Ross; r-package-devel@r-project.org
Subject: Re: [R-pkg-devel] relation between vignettes and help files
..
It is even worse, isn't it: Nowadays html help pages are (almost)
always created *dynamically* via R's help() or help.start();
For my setup of 1000s of packages in my libr
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,
t: Friday, July 15, 2016 5:32 AM
> To: Duncan Murdoch
> Cc: Enrico Schumann; Boylan, Ross; r-package-devel@r-project.org
> Subject: Re: [R-pkg-devel] relation between vignettes and help files
>
> ..
> It is even worse, isn't it: Nowadays html help pages are (almost)
> alwa
e substantive division of info
> between help files and
> vignettes?
> Ross
>
> From: Martin Maechler [maech...@stat.math.ethz.ch]
> Sent: Friday, July 15, 2016 5:32 AM
> To: Duncan Murdoch
> Cc: Enrico Schumann; Boylan, Ross; r-pack
: Duncan Murdoch
Cc: Enrico Schumann; Boylan, Ross; r-package-devel@r-project.org
Subject: Re: [R-pkg-devel] relation between vignettes and help files
..
It is even worse, isn't it: Nowadays html help pages are (almost)
always created *dynamically* via R's help() or help.start();
For m
> 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
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 vignettes and help files. By "help files" I mean the
regular .Rd files.
Substantively, to what extent should material
On Wed, 13 Jul 2016, "Boylan, Ross" writes:
> I have two questions, one substantive and one technical, about the
> relation between vignettes and help files. By "help files" I mean the
> regular .Rd files.
>
> Substantively, to what extent should material be duplicated between
> the help files a
Afaik the only way to link to a vignette from the help file is to instruct
the reader to do something like
vignette('intro','mypkg')
On the R command-line.
In general, the Rd files describe the public API of your pkg. Each exported
function should have a help file that ideally can be read and un
I have two questions, one substantive and one technical, about the relation
between vignettes and help files. By "help files" I mean the regular .Rd files.
Substantively, to what extent should material be duplicated between the help
files and the vignette? For example, my vignette includes som
11 matches
Mail list logo
