Scaffolds a CRAN-compliant RMarkdown vignette by interactively prompting the user for metadata, narrative structure, and target functions to highlight.
Value
Invisibly returns a named list with components: status ("done",
"cancelled", or "error"), file_path, package, title,
template, and functions (character vector).
Details
The function guides the user through the following process:
Collects package name and vignette title.
Prompts for a structural template (Quick Start, Deep Dive, or Case Study).
Requests a list of core functions to be featured in the vignette.
Generates a `.Rmd` file with a proper YAML header and a narrative scaffold based on the selected template.
Warning
This function modifies files on disk or the global environment. Please ensure you have a backup or are using version control (e.g., Git) before execution.
Examples
if (interactive()) {
architect_vignette()
}