[Rd] Parametrized Vignettest in R packages
murdoch@dunc@n @ending from gm@il@com
Mon Jul 2 17:21:28 CEST 2018
On 02/07/2018 10:34 AM, Gabe Becker wrote:
> Vignettes, in the package sense, are and must be entirely self-contained as
> far as I know. They are run automatically in completely clean R sessions.
> I'm not sure a parameterized vignette makes a ton of sense within that
The defaults for parameters are contained in the source, so a vignette
using default parameter values would be completely self-contained.
It seems like a good way to document parameterized reports: Include one
as a vignette that has more explanation about what the parameters mean,
how they are used, etc. Then users can try it out with new parameter
values before customizing it to their own needs.
> Can you explain what you would want to have happen when the package is
> built that would require parameterization?
> On Mon, Jul 2, 2018 at 7:30 AM, Witold E Wolski <wewolski using gmail.com> wrote:
>> I have a package which includes some parameterized r-markdown report
>> which I would also like to build as package vignettes.
>> Is there a way to run the parameterized vignette creation with the
>> package build or package check?
>> Thank you
>> Witold Eryk Wolski
>> R-devel using r-project.org mailing list
More information about the R-devel