rixpress/_pkgdown.yml at main · ropensci/rixpress · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
url: https://b-rodrigues.github.io/rixpress/
template:
  bootstrap: 5

articles:
- title: Introduction
  navbar: Introduction
  contents:
  - intro-concepts
  - scope
  - core-functions
  - tutorial
  - importing-data
  - debugging
  - gc
- title: Polyglot pipelines
  navbar: Polyglot pipelines
  contents:
  - polyglot
  - polyglot-julia
  - encoding-decoding
- title: Advanced topics
  navbar: Advanced topics
  contents:
  - sub-pipelines
  - ci
  - cmdstanr
  - chronicler

reference:
- title: Declaring derivations
  desc: >
    Functions that define Nix derivations that run R or Python code, or compile Quarto or R Markdown documents.
  contents: has_concept("derivations")

- title: Building the pipeline
  desc: >
    Functions to generate and build the Nix pipeline
  contents: has_concept("pipeline functions")

- title: Pipeline organization
  desc: >
    Functions for organizing derivations into named sub-pipelines with visual distinction in DAG visualizations.
  contents:
  - rxp_pipeline
  - print.rxp_pipeline

- title: Project utilities
  desc: >
    Functions for initializing projects, copying outputs, reading derivations, and inspecting build artifacts.
  contents: has_concept("utilities")

- title: Archive import/export
  desc: >
    Functions for importing and exporting Nix store paths using archive files.
  contents: has_concept("archive caching functions")

- title: DAG and CI tools
  desc: >
    Tools for generating DAGs and preparing pipelines for rendering or deployment in CI environments.
  contents: has_concept("ci utilities")

- title: R ↔ Python interop
  desc: >
    Functions to move data and objects between R and Python runtimes.
  contents: has_concept("interop functions")

- title: Visualization
  desc: >
    Functions for visualizing pipeline DAGs using different backends.
  contents: has_concept("visualisation functions")

- title: Python import manipulation
  desc: >
    Utilities to adjust Python import statements to match project or environment conventions.
  contents: has_concept("python import")