-
Notifications
You must be signed in to change notification settings - Fork 154
Description
It would be very convenient to have an explicit argument for building vignettes for the family of install_*() functions. This would be similar to what was available via the build_vignettes argument in the pre-remotes (before version 2.0.0) version of devtools::install_*(), which still survives in the current devtools::install().
Although one can manually specify build_opts = c("--no-resave-data", "--no-manual"), an explicit argument is particularly useful when describing e.g. how to install a package from GitHub in its README. One typically wants vignettes to be available to the user installing the package, especially if the package is not on CRAN. In this regard, an explicit
remotes::install_github("my/pkg", build_vignettes = TRUE)is a lot more informative for the user than
remotes::install_github("my/pkg", build_opts = c("--no-resave-data", "--no-manual"))where it is not evident this is not about the specified biuld_opts but about "excluding the exclusion of vignettes from the pkg build".
Or would you recommend for such cases to even use build_opts = NULL for a fully-fledged build?