rmd_to_vignettes: Convert R markdown scripts to vignettes

View source: R/rmd_to_vignette.R

rmd_to_vignettesR Documentation

Convert R markdown scripts to vignettes

Description

[Experimental]

Copies (by default) all scripts s01_XXX.Rmd, s02_XXX.Rmd into the "vignettes" and reformats so they meet vignette standards. Use of devtools::build_vignettes() can then be used to build vignettes.

Usage

rmd_to_vignettes(script_files, overwrite = FALSE)

Arguments

script_files

Optional character vector of scripts. If empty will find scripting making the s##_XXX.Rmd convention. Must be .Rmd files

overwrite

Logical (default = FALSE). Overwrites existing vignettes of the same name.

Details

Uses of decision() must pass without stopping so these must have been run interactively prior to use of devtools::build_vignettes().

Value

No return value, called for side effects.


NMproject documentation built on Sept. 30, 2022, 1:06 a.m.