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
I second Dirk. Also, from my experience:
A good rule of thumb is that you should fix all NOTEs (i.e. not have
them) when you submit to CRAN. It's only when you have a really good
reason you could try to convince CRAN that they are there and that
they cannot be fixed easily. I've got 20+ package
