kuva 0.1.6

Scientific plotting library in Rust with various backends.
Documentation 
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214

//! Sankey diagram documentation examples.
//!
//! Generates canonical SVG outputs used in the kuva documentation.
//! Run with:
//!
//! ```bash
//! cargo run --example sankey
//! ```
//!
//! SVGs are written to `docs/src/assets/sankey/`.

use kuva::plot::SankeyPlot;
use kuva::backend::svg::SvgBackend;
use kuva::render::render::render_multiple;
use kuva::render::layout::Layout;
use kuva::render::plots::Plot;
use kuva::TickFormat;

const OUT: &str = "docs/src/assets/sankey";

fn main() {
    std::fs::create_dir_all(OUT).expect("could not create docs/src/assets/sankey");

    basic();
    node_colors();
    gradient();
    variant_filter();
    flow_labels_absolute();
    flow_labels_percent();
    flow_labels_pipeline();

    println!("Sankey SVGs written to {OUT}/");
}

/// Basic 3-stage pipeline — nodes auto-colored, columns auto-assigned.
fn basic() {
    let sankey = SankeyPlot::new()
        .with_link("Input", "Process A", 50.0)
        .with_link("Input", "Process B", 30.0)
        .with_link("Process A", "Output X", 40.0)
        .with_link("Process A", "Output Y", 10.0)
        .with_link("Process B", "Output X", 10.0)
        .with_link("Process B", "Output Y", 20.0);

    let plots = vec![Plot::Sankey(sankey)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Energy Flow");

    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    std::fs::write(format!("{OUT}/basic.svg"), svg).unwrap();
}

/// Explicit node colors and a per-node legend.
fn node_colors() {
    let sankey = SankeyPlot::new()
        .with_node_color("Input", "#888888")
        .with_node_color("Process A", "#377eb8")
        .with_node_color("Process B", "#4daf4a")
        .with_node_color("Output", "#984ea3")
        .with_link("Input", "Process A", 40.0)
        .with_link("Input", "Process B", 30.0)
        .with_link("Process A", "Output", 35.0)
        .with_link("Process B", "Output", 25.0)
        .with_node_width(24.0)
        .with_legend("Stage");

    let plots = vec![Plot::Sankey(sankey)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Node Colors & Legend");

    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    std::fs::write(format!("{OUT}/node_colors.svg"), svg).unwrap();
}

/// Gradient ribbons — each ribbon fades from source to target color.
fn gradient() {
    let sankey = SankeyPlot::new()
        .with_node_color("Budget", "#e41a1c")
        .with_node_color("R&D", "#377eb8")
        .with_node_color("Marketing", "#4daf4a")
        .with_node_color("Ops", "#ff7f00")
        .with_node_color("Product A", "#984ea3")
        .with_node_color("Product B", "#a65628")
        .with_link("Budget", "R&D",       40.0)
        .with_link("Budget", "Marketing", 25.0)
        .with_link("Budget", "Ops",       35.0)
        .with_link("R&D",       "Product A", 25.0)
        .with_link("R&D",       "Product B", 15.0)
        .with_link("Marketing", "Product A", 15.0)
        .with_link("Marketing", "Product B", 10.0)
        .with_link("Ops",       "Product A", 20.0)
        .with_link("Ops",       "Product B", 15.0)
        .with_gradient_links()
        .with_link_opacity(0.6);

    let plots = vec![Plot::Sankey(sankey)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Budget Allocation — Gradient Ribbons");

    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    std::fs::write(format!("{OUT}/gradient.svg"), svg).unwrap();
}

/// Absolute flow labels — RNA-seq read processing pipeline, unit suffix "reads".
fn flow_labels_absolute() {
    let sankey = SankeyPlot::new()
        .with_link("Raw reads",  "Trimmed",        82.0)
        .with_link("Raw reads",  "Discarded",        3.0)
        .with_link("Trimmed",    "Genome aligned",  68.0)
        .with_link("Trimmed",    "rRNA",             8.0)
        .with_link("Trimmed",    "Unmapped",         6.0)
        .with_link("Genome aligned", "Exonic",      42.0)
        .with_link("Genome aligned", "Intronic",    18.0)
        .with_link("Genome aligned", "Intergenic",   8.0)
        .with_flow_labels()
        .with_flow_label_unit("M reads")
        .with_link_opacity(0.5);

    let plots = vec![Plot::Sankey(sankey)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("RNA-seq Pipeline — Absolute Flow (M reads)");

    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    std::fs::write(format!("{OUT}/flow_labels_absolute.svg"), svg).unwrap();
}

/// Percentage flow labels — fraction of each source node's total outflow.
fn flow_labels_percent() {
    let sankey = SankeyPlot::new()
        .with_node_color("Raw reads",        "#888888")
        .with_node_color("Trimmed",          "#4daf4a")
        .with_node_color("Discarded",        "#e41a1c")
        .with_node_color("Genome aligned",   "#377eb8")
        .with_node_color("rRNA",             "#ff7f00")
        .with_node_color("Unmapped",         "#cccccc")
        .with_link("Raw reads",  "Trimmed",        82.0)
        .with_link("Raw reads",  "Discarded",        3.0)
        .with_link("Trimmed",    "Genome aligned",  68.0)
        .with_link("Trimmed",    "rRNA",             8.0)
        .with_link("Trimmed",    "Unmapped",         6.0)
        .with_flow_percent()
        .with_link_opacity(0.5);

    let plots = vec![Plot::Sankey(sankey)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("RNA-seq Pipeline — % of Source Outflow");

    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    std::fs::write(format!("{OUT}/flow_labels_percent.svg"), svg).unwrap();
}

/// Large-count pipeline with scientific notation labels.
fn flow_labels_pipeline() {
    let sankey = SankeyPlot::new()
        .with_node_color("Raw Variants",  "#888888")
        .with_node_color("QC Pass",       "#4daf4a")
        .with_node_color("QC Fail",       "#e41a1c")
        .with_node_color("High Conf",     "#377eb8")
        .with_node_color("Low Conf",      "#ff7f00")
        .with_node_color("SNP",           "#984ea3")
        .with_node_color("Indel",         "#a65628")
        .with_node_color("Filtered Out",  "#cccccc")
        .with_link("Raw Variants", "QC Pass",      8_000_000.0)
        .with_link("Raw Variants", "QC Fail",      2_000_000.0)
        .with_link("QC Pass",      "High Conf",    6_000_000.0)
        .with_link("QC Pass",      "Low Conf",     2_000_000.0)
        .with_link("High Conf",    "SNP",          4_500_000.0)
        .with_link("High Conf",    "Indel",        1_200_000.0)
        .with_link("High Conf",    "Filtered Out",   300_000.0)
        .with_link("Low Conf",     "SNP",            800_000.0)
        .with_link("Low Conf",     "Filtered Out", 1_200_000.0)
        .with_flow_labels()
        .with_flow_label_format(TickFormat::Sci)
        .with_link_opacity(0.45)
        .with_legend("Stage");

    let plots = vec![Plot::Sankey(sankey)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Variant Filtering — Scientific Notation Labels");

    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    std::fs::write(format!("{OUT}/flow_labels_pipeline.svg"), svg).unwrap();
}

/// Wide 4-stage variant-filtering pipeline — a bioinformatics use case.
fn variant_filter() {
    let sankey = SankeyPlot::new()
        .with_node_color("Raw Variants",  "#888888")
        .with_node_color("QC Pass",       "#4daf4a")
        .with_node_color("QC Fail",       "#e41a1c")
        .with_node_color("High Conf",     "#377eb8")
        .with_node_color("Low Conf",      "#ff7f00")
        .with_node_color("SNP",           "#984ea3")
        .with_node_color("Indel",         "#a65628")
        .with_node_color("Filtered Out",  "#cccccc")
        .with_link("Raw Variants", "QC Pass",      8000.0)
        .with_link("Raw Variants", "QC Fail",      2000.0)
        .with_link("QC Pass",      "High Conf",    6000.0)
        .with_link("QC Pass",      "Low Conf",     2000.0)
        .with_link("High Conf",    "SNP",          4500.0)
        .with_link("High Conf",    "Indel",        1200.0)
        .with_link("High Conf",    "Filtered Out",  300.0)
        .with_link("Low Conf",     "SNP",           800.0)
        .with_link("Low Conf",     "Filtered Out", 1200.0)
        .with_link_opacity(0.45)
        .with_legend("Stage");

    let plots = vec![Plot::Sankey(sankey)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Variant Filtering Pipeline");

    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    std::fs::write(format!("{OUT}/variant_filter.svg"), svg).unwrap();
}