framework docs
Notebooks & Scripts

make_rmd()

Create an RMarkdown Notebook

Convenient alias for make_notebook(type = "rmarkdown"). Creates a .Rmd file from stub templates.

Usage

make_rmd(name, dir = NULL, stub = "default", overwrite = FALSE, subdir = NULL)

Arguments

name
Character. The file name (with or without .Rmd extension)
dir
Character. Directory to create the file in. Uses your project's configured `directories$notebooks` setting. Default: "notebooks/".
stub
Character. Name of the stub template to use. Default "default".
overwrite
Logical. Whether to overwrite existing file. Default FALSE.
subdir
Optional subdirectory under `dir` (e.g., "analyses/exploratory").

Value

Invisible path to created notebook

Examples

if (FALSE) {
# Create notebooks/analysis.Rmd
make_rmd("analysis")
# Use custom stub
make_rmd("report", stub = "minimal")
# Create in specific directory
make_rmd("explore", dir = "work")
}

See also