Skip to contents

Initialize pipeline

Source: R/rxp_init.R
rxp_init.Rd

Generates gen-env.R and gen-pipeline.R scripts in the specified project directory.

Usage

rxp_init(project_path, overwrite = FALSE)

Arguments

project_path

Character string specifying the project's path.

overwrite

Logical, defaults to FALSE, indicating whether to overwrite existing scripts.

Details

Creates:

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

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

Examples

# Default usage
rxp_init()
#> Error in rxp_init(): argument "project_path" is missing, with no default

# Custom path with overwrite
rxp_init(project_path = "my_project", overwrite = TRUE)
#> File my_project/gen-env.R has been written.
#> File my_project/gen-pipeline.R has been written.