Skip to contents

Initialize rixpress project

Source: R/rxp_init.R
rxp_init.Rd

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.

Value

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

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}.

See also

Other utilities: print.derivation(), rxp_copy(), rxp_inspect(), rxp_list_logs(), rxp_load(), rxp_read()

Examples

# Default usage (will prompt before any action)
if (FALSE) { # \dontrun{
  rxp_init()
} # }