rxp_init: Initialize Rixpress Project

In rixpress: Build Reproducible Analytical Pipelines with 'Nix'

Initialize Rixpress Project

Description

Generates gen-env.R and gen-pipeline.R scripts in the specified project directory, after asking the user for confirmation. If the user declines, no changes are made.

Usage

rxp_init(project_path = ".", skip_prompt = FALSE)

Arguments

project_path	Character string specifying the project's path.
skip_prompt	Logical. If TRUE, skips all confirmation prompts and proceeds with initialization, useful on continuous integration. Defaults to FALSE.

Details

Creates (overwriting if they already exist):

• gen-env.R: Script to define an execution environment with {rix}.

• gen-pipeline.R: Defines a data pipeline with {rixpress}.

Value

Logical. Returns TRUE if initialization was successful, FALSE if the operation was cancelled by the user.

See Also

Other utilities: print.rxp_derivation(), rxp_check_chronicles(), rxp_copy(), rxp_gc(), rxp_inspect(), rxp_list_logs(), rxp_load(), rxp_read(), rxp_trace()

Examples

# Default usage (will prompt before any action)
## Not run: 
  rxp_init()

## End(Not run)

rixpress documentation built on Feb. 19, 2026, 9:06 a.m.