Skip to contents

Declaring derivations

Functions that define Nix derivations that run R or Python code, or compile Quarto or R Markdown documents.

rxp_jl()
Create a Nix Expression Running a Julia Function
rxp_jl_file()
Creates a Nix Expression That Reads In a File (or Folder of Data) Using Julia
rxp_py()
Create a Nix Expression Running a Python Function
rxp_py_file()
Creates a Nix Expression That Reads In a File (or Folder of Data) Using Python
rxp_qmd()
Render a Quarto Document as a Nix Derivation
rxp_r()
Create a Nix Expression Running an R Function
rxp_r_file()
Creates a Nix Expression That Reads In a File (or Folder of Data) Using R
rxp_rmd()
Render an R Markdown Document as a Nix Derivation

Building the pipeline

Functions to generate and build the Nix pipeline

rxp_make()
Build Pipeline Using Nix
rxp_pipeline()
Create a Named Pipeline of Derivations
rxp_populate()
Generate Nix Pipeline Code

Pipeline organization

Functions for organizing derivations into named sub-pipelines with visual distinction in DAG visualizations.

rxp_pipeline()
Create a Named Pipeline of Derivations
print(<rxp_pipeline>)
Print Method for rxp_pipeline Objects

Project utilities

Functions for initializing projects, copying outputs, reading derivations, and inspecting build artifacts.

print(<rxp_derivation>)
Print Method for Derivation Objects
rxp_check_chronicles()
Check Pipeline Outputs for Chronicle Status
rxp_copy()
Copy Derivations From the Nix Store to Current Working Directory
rxp_gc()
Garbage Collect Rixpress Build Artifacts and Logs
rxp_init()
Initialize Rixpress Project
rxp_inspect()
Inspect the Build Result of a Pipeline
rxp_list_logs()
List All Available Build Logs
rxp_load()
Load Output of a Derivation
rxp_read()
Read Output of a Derivation
rxp_trace()
Trace Lineage of Derivations

Archive import/export

Functions for importing and exporting Nix store paths using archive files.

rxp_export_artifacts()
Export Nix Store Paths to an Archive
rxp_import_artifacts()
Import Nix Store Paths from an Archive

DAG and CI tools

Tools for generating DAGs and preparing pipelines for rendering or deployment in CI environments.

rxp_dag_for_ci()
Export DAG of Pipeline and Prepare It for Rendering on CI
rxp_ga()
Run a Pipeline on GitHub Actions
rxp_write_dag()
Generate a DAG From a List of Derivations

R ↔︎ Python interop

Functions to move data and objects between R and Python runtimes.

rxp_py2r()
Transfer Python Object into an R Session
rxp_r2py()
Transfer R Object into a Python Session

Visualization

Functions for visualizing pipeline DAGs using different backends.

rxp_ggdag()
Create a Directed Acyclic Graph (DAG) Representing the Pipeline Using ggplot2
rxp_visnetwork()
Create a Directed Acyclic Graph (DAG) Representing the Pipeline Using visNetwork

Python import manipulation

Utilities to adjust Python import statements to match project or environment conventions.

add_import()
Add an Import Statement to Python Files in the _rixpress Folder Matching a Nix Environment Name This function appends a specified import statement to the end of each Python file within the _rixpress folder and its subdirectories, but only for files whose base name matches the provided Nix environment.
adjust_import()
Adjust Python Import Statements