distribute custom.scss for quarto vignettes via R package

[LiNk-NY]

Hi Christophe ! @cderv

Thank you for following up on my question at quarto-dev/quarto-cli#2307 (reply in thread)!

But you want this custom.scss to be in your package as an extension you would install?

I did create a custom format with the _extensions but it does not work for R package vignettes IIUC.

Or ship within the package ? Is this custom.scss used only for the vignette ? Or is this something you want to make available to others, and why you have a custom format ?

Yes, I do have an R / Bioconductor package that would distribute the custom.scss within it. The custom.scss would be used for both the package vignette and made available for others to use (though the latter is higher priority).

[cderv]

Thanks for reaching out. I think we'll need to work on a simple example to understand this.

I want to reiterate my warnings: Using a quarto extension with a vignette means that the vignette files in vignettes/ will have a dependency on _extensions, and so it needs to be taking care of carefully as when you need to provide other resources. Probably .install_extras is required

Those resources can help:

• https://blog.r-hub.io/2020/06/03/vignettes/#overview-of-vignettes-states
• https://cran.r-project.org/doc/manuals/r-release/R-exts.html#index-_002einstall_005fextras-file
• https://r-pkgs.org/vignettes.html but does not mentioned how to include resources.

Yes, I do have an R / Bioconductor package that would distribute the custom.scss within it
The custom.scss would be used for both the package vignette and made available for others to use (though the latter is higher priority).

Ok so it would be into inst/ right ?

I don't know if there would be a way to reuse this for vignettes using Quarto without having a copy of it in your extension.

SO I think making this work rely one

• What is the state of your Quarto extension for custom format ? Is this only used to ship the custom scss ?
• Can CRAN or Bioconductior support building a vignette that depends on a quarto extension ?

This is not directly related to the engine itself. It is about the structure and expectation for R CMD build and R CMD check

[LiNk-NY]

I don't know if there would be a way to reuse this for vignettes using Quarto without having a copy of it in your extension.

Thanks for this bit of useful information. It seems that we would have to go the route of copying the necessary files into the vignettes folder and providing a Quarto template that plays well with R CMD check

What is the state of your Quarto extension for custom format ? Is this only used to ship the custom scss ?

The extension so far is quite minimal and can be seen here : https://github.com/Bioconductor/BiocStyle/tree/quarto/inst/extdata/_extensions/biocstyle
It may not be worth installing an extension given that it is mainly the scss file and some format: html configurations.

Can CRAN or Bioconductior support building a vignette that depends on a quarto extension ?

Bioconductor does have the Quarto CLI installed on the Bioconductor Build System (BBS) but we run R CMD build and R CMD check on packages, so no special treatment for vignettes.