Use vignette: Get started — use_vignette

Creates a "Get started" rmarkdown vignette file.

use_vignette_getstarted(
  package = names(get_description()),
  title = "Get started",
  vignette_index_entry = package,
  save_dir = here::here(),
  path = file.path(save_dir, "vignettes", paste0(package, ".Rmd")),
  output = "BiocStyle::html_document",
  force_new = FALSE,
  show = FALSE,
  verbose = TRUE
)

Arguments

package: R package name.
title: Title of vignette.
vignette_index_entry: Index entry of the vignette, which is used when creating the navigation bar in the pkgdown site.
save_dir: Directory to save the file to.
path: Path to the file.
output: Vignette output style. Defaults to html_document.
force_new: If the file already exists, overwrite it (default: FALSE).
show: Print the contents of the file in the R console.
verbose: Print messages.

Value

Path to vignette file.

Examples

path <- use_vignette_getstarted(package = "mypackage",
                                ## use default save_dir in practice
                                save_dir = tempdir())
#> Creating new vignette file ==> /tmp/RtmppaN4bb/vignettes/mypackage.Rmd