[R-pkg-devel] Suppressing long-running vignette code in CRAN submission

John Fox j|ox @end|ng |rom mcm@@ter@c@
Tue Oct 17 23:10:44 CEST 2023


Hello Duncan,

On 2023-10-17 4:43 p.m., Duncan Murdoch wrote:
> Caution: External email.
> 
> 
> On 17/10/2023 4:21 p.m., John Fox wrote:
>> Hello Simon,
>>
>> On 2023-10-17 3:51 p.m., Simon Urbanek wrote:
>>> Caution: External email.
>>>
>>>
>>> John,
>>>
>>> the short answer is it won't work (it defeats the purpose of vignettes).
>>
>> Thank you for confirming that.
>>
>>>
>>> However, this sounds like a purely hypothetical question - CRAN 
>>> policies allow long-running vignettes if they declared.
>>
>> I assume that we'd declare the long-running vignette in our submission
>> note to CRAN. Maybe that's better than pre-building the HTML vignettes
>> in the package.
>>
> 
> 
> There's also the "BuildVignettes: false" field in DESCRIPTION, but its
> use is discouraged, and I don't think it allows you to ask CRAN to build
> some vignettes but not all.

Thanks, I wasn't aware of that. There are two vignettes, one of which is 
slow to build.

Given Simon's suggestion, we'll likely submit the package with a note 
about the long-running vignette, and if that proves problematic, we can 
use R.asp to pre-build the HTML vignettes.

Best,
  John

> 
> Duncan Murdoch
> 
>> Best,
>>    John
>>
>>>
>>> Cheers,
>>> Simon
>>>
>>>
>>>> On 18/10/2023, at 3:02 AM, John Fox <jfox using mcmaster.ca> wrote:
>>>>
>>>> Hello Dirk,
>>>>
>>>> Thank you (and Kevin and John) for addressing my questions.
>>>>
>>>> No one directly answered my first question, however, which was 
>>>> whether the approach that I suggested would work. I guess that the 
>>>> implication is that it won't, but it would be nice to confirm that 
>>>> before I try something else, specifically using R.rsp.
>>>>
>>>> Best,
>>>> John
>>>>
>>>> On 2023-10-17 4:02 a.m., Dirk Eddelbuettel wrote:
>>>>> Caution: External email.
>>>>> On 16 October 2023 at 10:42, Kevin R Coombes wrote:
>>>>> | Produce a PDF file yourself, then use the "as.is" feature of the 
>>>>> R.rsp
>>>>> | package.
>>>>> For completeness, that approach also works directly with Sweave. 
>>>>> Described in
>>>>> a blog post by Mark van der Loo in 2019, and used in a number of 
>>>>> packages
>>>>> including a few of mine.
>>>>> That said, I also used the approach described by John Harrold and 
>>>>> cached
>>>>> results myself.
>>>>> Dirk
>>>>> -- 
>>>>> dirk.eddelbuettel.com | @eddelbuettel | edd using debian.org
>>>>> ______________________________________________
>>>>> R-package-devel using r-project.org mailing list
>>>>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>>>>
>>>> ______________________________________________
>>>> R-package-devel using r-project.org mailing list
>>>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>>>>
>>>
>>
>> ______________________________________________
>> R-package-devel using r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>




More information about the R-package-devel mailing list