Framework Framework

Getting Started

Installation Setup Conventions settings.yml framework.db New Project

Features

scaffold() Packages Data Management Functions Templates Quarto Integration Viewing Work Saving Work Git Integration AI Assistants Caching Connections Environment Publishing
API Reference Blog

Notebooks & Scripts

make_script

Create an R Script from Stub Template

Convenience wrapper for `make_notebook()` that creates R scripts (.R files). This is identical to calling `make_notebook("name.R")`.

Usage

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

Arguments

Argument Description
name

Character. The script name (with or without .R extension). Examples: "process-data", "process-data.R"
dir

Character. Directory to create the script in. Uses your project's configured directories$scripts setting. Default: "scripts/".
stub

Character. Name of the stub template to use. Defaults to "default". User can create custom stubs in stubs/script-{stub}.R.
overwrite

Logical. Whether to overwrite existing file. Default FALSE.

Details

This function is a convenience wrapper that:

  1. Ensures the name ends with .R extension
  2. Uses script_dir config option instead of notebook_dir
  3. Calls make_notebook() with type = "script"
    Default Output

Scripts are created in the scripts/ directory by default:

scripts/
  process-data.R
  build-features.R
  run-model.R

Returns

Invisible path to created script

Examples

# Create script (extension optional)
make_script("process-data")
make_script("process-data.R")

# Use custom stub
make_script("etl-pipeline", stub = "etl")

# Create in specific directory
make_script("analysis", dir = "analysis/")

See Also

Source: R/make_script.R