use_vignette_in_dir: Create Vignette Document in Sub-directory

In charlotte-ngs/rmdhelp: RMarkdown Helper

Create Vignette Document in Sub-directory

Description

A vignette is created in a separate subdirectory. The subdirectory by default is the same as the file-name of the vignette. If the vignette name contains a directory path, then it is saved under that directory.

Usage

use_vignette_in_dir(
  ps_name,
  ps_vig_dir = NULL,
  ps_title = fs::path_ext_remove(ps_name),
  ps_template = "vignette",
  ps_pkg = "rmdhelp",
  pb_open = TRUE
)

Arguments

ps_name	Base of vignette file name
ps_vig_dir	alternative target directory for document root (default: vignettes)
ps_title	Title of vignette
ps_template	Name of template to be used
pb_open	Directly open the vignette

Examples

## Not run: 
use_vignette_in_dir("example-vignette", "Example Vignette")
use_vignette_in_dir(ps_name     = "example_bookdown",
                    ps_title    = "Example Bookdown Document",
                    ps_template = "bookdown")

## End(Not run)

charlotte-ngs/rmdhelp documentation built on Oct. 31, 2023, 10:21 a.m.