From murdoch@dunc@n @ending from gm@il@com  Mon Jul  2 17:21:28 2018
From: murdoch@dunc@n @ending from gm@il@com (Duncan Murdoch)
Date: Mon, 2 Jul 2018 11:21:28 -0400
Subject: [Rd] Parametrized Vignettest in R packages
In-Reply-To: <CAMFmJskNvcpe-DX3YxebLx0bcozJFpUGnJqNkTPqcO4vEPOCLQ@mail.gmail.com>
References: <CAAjnpdhaeX+=RXCmq3g7jwYQZanfvps1q5i5znmynAGqxb1MPw@mail.gmail.com>
 <CAMFmJskNvcpe-DX3YxebLx0bcozJFpUGnJqNkTPqcO4vEPOCLQ@mail.gmail.com>
Message-ID: <60ded1f0-7bce-477d-be59-f354ca4ff6f2@gmail.com>

On 02/07/2018 10:34 AM, Gabe Becker wrote:
> Witold,
> 
> 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
> context.

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.

Duncan Murdoch

> 
> Can you explain what you would want to have happen when the package is
> built that would require parameterization?
> 
> ~G
> 
> On Mon, Jul 2, 2018 at 7:30 AM, Witold E Wolski <wewolski at gmail.com> wrote:
> 
>> Hello,
>>
>> 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 at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>
>>
> 
>



[Rd] Parametrized Vignettest in R packages
Duncan Murdoch