Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VignetteBuilder: field of DESCRIPTION should declare all builder deps #3392

Closed
infotroph opened this issue Oct 21, 2024 · 3 comments
Closed
Assignees

Comments

@infotroph
Copy link
Member

infotroph commented Oct 21, 2024

From "Writing R Extensions" (emphasis theirs):

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.

@harshagr70
Copy link
Contributor

Hi @infotroph ! I’d like to work on this issue if it’s still available. Could you please assign it to me? I’m ready to get started on a fix. Thanks!

@harshagr70
Copy link
Contributor

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!

infotroph added a commit that referenced this issue Nov 4, 2024
Updated VignetteBuilder field to include knitr and rmarkdown
@infotroph
Copy link
Member Author

Fixed by #3394. Thank you, @harshagr70!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants