Do not build vignettes for GH packages by default

[gaborcsardi]

Maybe? And have an option for all packages.

[e-kotov]

I don't see {pak} building vignettes when install from GitHub at all. Whenever I install a package from GitHub using {pak}, there are no vignettes after the installation. And I could not find an argument in any of {pak}'s functions to control that.

[gaborcsardi]

IDK why this is not documented, but you need to set the PKG_BUILD_VIGNETTES=true env var, or potentially the pkg.build_vignettes = TRUE option also works.

[e-kotov]

Thanks for the tips!

or potentially the pkg.build_vignettes = TRUE option also works.

returns unused argument (pkg.build_vignettes = TRUE)

And that's to be expected, as pkg_install() does not have the ... argument, so it will just refuse anything not listed.

PKG_BUILD_VIGNETTES=true

Sys.setenv(PKG_BUILD_VIGNETTES=TRUE)

That works!

[e-kotov]

@gaborcsardi out of curiosity, how does Sys.setenv(PKG_BUILD_VIGNETTES=TRUE) magically works, if the package source does not have any code that would read this env var? At least I am failing to find it.

[gaborcsardi]

returns unused argument (pkg.build_vignettes = TRUE)

It is an option, so do options(pkg.build_vignettes = TRUE).

if the package source does not have any code that would read this env var?

pak/src/library/pkgdepends/R/zzz-pkgdepends-config.R

Line 73 in 64a34ee

build_vignettes = list(

[e-kotov]

It is an option, so do options(pkg.build_vignettes = TRUE)

Ahhh! thanks!