You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The ‘VignetteBuilder’ field names (in a comma-separated list) packages that provide an engine for building vignettes. These may include the current package, or ones listed in ‘Depends’, ‘Suggests’ or ‘Imports’. The utils package is always implicitly appended. See Section 1.4.2 [Non-Sweave vignettes], page 48, for details. Note that if, for example, a vignette has engine ‘knitr::rmarkdown’, then knitr (https://CRAN.R-project.org/package=knitr) provides the engine but both knitr and rmarkdown (https://CRAN.R-project.org/package=rmarkdown) are needed for using it, so both these packages need to be in the ‘VignetteBuilder’ field and at least suggested (as rmarkdown is only suggested by knitr, and hence not available automatically along with it). Many packages using knitr (https://CRAN.R-project.org/package=knitr) also need the package formatR (https://CRAN.R-project.org/package=formatR) which it suggests and so the user package needs to do so too and include this in ‘VignetteBuilder’.
Since all our vignettes use knitr::rmarkdown, my takeaway is that we need to replace VignetteBuilder: knitr with VignetteBuilder: knitr, rmarkdown in all packages that have vignettes.
The text was updated successfully, but these errors were encountered:
Hi @infotroph I've opened a PR #3394 to address this issue. I believe it addresses the problem, but I'd welcome any feedback or suggestions for improvement. Thanks!
harshagr70
added a commit
to harshagr70/pecan
that referenced
this issue
Nov 2, 2024
From "Writing R Extensions" (emphasis theirs):
Since all our vignettes use
knitr::rmarkdown
, my takeaway is that we need to replaceVignetteBuilder: knitr
withVignetteBuilder: knitr, rmarkdown
in all packages that have vignettes.The text was updated successfully, but these errors were encountered: