kuva 0.2.0

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

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

use kuva::backend::svg::SvgBackend;
use kuva::plot::venn::VennPlot;
use kuva::render::layout::Layout;
use kuva::render::plots::Plot;
use kuva::render::render::render_multiple;
use std::fs;

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

fn write(name: &str, plots: Vec<Plot>, layout: Layout) {
    fs::create_dir_all(OUT).unwrap();
    let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
    fs::write(format!("{OUT}/{name}.svg"), svg).unwrap();
}

fn main() {
    // ── 1. Basic 2-set: two gene lists ───────────────────────────────────────
    let deseq2_genes = vec![
        "BRCA1", "TP53", "MYC", "EGFR", "VEGFA", "CDKN2A", "KRAS", "PTEN", "MDM2", "RB1", "CCND1",
        "CDK4",
    ];
    let edger_genes = vec![
        "TP53", "MYC", "KRAS", "PIK3CA", "PTEN", "RB1", "AKT1", "MTOR", "CDK4", "CCND1", "ERBB2",
    ];

    let venn = VennPlot::new()
        .with_set(
            "DESeq2",
            deseq2_genes.iter().map(|s| s.to_string()).collect(),
        )
        .with_set("edgeR", edger_genes.iter().map(|s| s.to_string()).collect())
        .with_percentages(true);
    let plots = vec![Plot::Venn(venn)];
    let layout = Layout::auto_from_plots(&plots).with_title("DE Gene Overlap: DESeq2 vs edgeR");
    write("basic_2set", plots, layout);
    println!("  basic_2set");

    // ── 2. Basic 3-set: three experimental gene lists ─────────────────────────
    let deseq2 = vec!["BRCA1", "TP53", "MYC", "EGFR", "VEGFA", "CDKN2A", "KRAS"];
    let edger = vec!["TP53", "MYC", "KRAS", "PIK3CA", "PTEN", "RB1"];
    let limma = vec!["BRCA1", "MYC", "EGFR", "PIK3CA", "CDKN2A", "MDM2"];

    let venn = VennPlot::new()
        .with_set("DESeq2", deseq2.iter().map(|s| s.to_string()).collect())
        .with_set("edgeR", edger.iter().map(|s| s.to_string()).collect())
        .with_set("limma", limma.iter().map(|s| s.to_string()).collect())
        .with_counts(true)
        .with_percentages(true);
    let plots = vec![Plot::Venn(venn)];
    let layout = Layout::auto_from_plots(&plots).with_title("DE Gene Overlap Across Methods");
    write("basic_3set", plots, layout);
    println!("  basic_3set");

    // ── 3. Proportional mode with loss display ────────────────────────────────
    let venn = VennPlot::new()
        .with_set_size("Proteomics", 850)
        .with_set_size("Transcriptomics", 1200)
        .with_set_size("Metabolomics", 600)
        .with_overlap(["Proteomics", "Transcriptomics"], 320)
        .with_overlap(["Proteomics", "Metabolomics"], 180)
        .with_overlap(["Transcriptomics", "Metabolomics"], 250)
        .with_overlap(["Proteomics", "Transcriptomics", "Metabolomics"], 90)
        .with_proportional(true)
        .with_loss(true)
        .with_counts(true);
    let plots = vec![Plot::Venn(venn)];
    let layout = Layout::auto_from_plots(&plots).with_title("Multi-omics Overlap (Proportional)");
    write("proportional", plots, layout);
    println!("  proportional");

    // ── 4. 4-set with leader lines ────────────────────────────────────────────
    // A 4-set diagram has 15 regions; the small central intersections are too
    // crowded to label inline, so leader_lines=true gives them external labels.
    let venn = VennPlot::new()
        .with_set_size("Condition A", 400)
        .with_set_size("Condition B", 350)
        .with_set_size("Condition C", 300)
        .with_set_size("Condition D", 250)
        .with_overlap(["Condition A", "Condition B"], 120)
        .with_overlap(["Condition A", "Condition C"], 90)
        .with_overlap(["Condition A", "Condition D"], 70)
        .with_overlap(["Condition B", "Condition C"], 100)
        .with_overlap(["Condition B", "Condition D"], 80)
        .with_overlap(["Condition C", "Condition D"], 60)
        .with_overlap(["Condition A", "Condition B", "Condition C"], 35)
        .with_overlap(["Condition A", "Condition B", "Condition D"], 25)
        .with_overlap(["Condition A", "Condition C", "Condition D"], 20)
        .with_overlap(["Condition B", "Condition C", "Condition D"], 30)
        .with_overlap(
            ["Condition A", "Condition B", "Condition C", "Condition D"],
            10,
        )
        .with_counts(true)
        .with_legend("Conditions")
        .with_leader_lines(true);
    let plots = vec![Plot::Venn(venn)];
    let layout = Layout::auto_from_plots(&plots).with_title("4-Set Venn with Leader Lines");
    write("leader_lines", plots, layout);
    println!("  leader_lines");

    // ── 5. 4-set with pre-computed sizes ─────────────────────────────────────
    let venn = VennPlot::new()
        .with_set_size("Condition A", 400)
        .with_set_size("Condition B", 350)
        .with_set_size("Condition C", 300)
        .with_set_size("Condition D", 250)
        .with_overlap(["Condition A", "Condition B"], 120)
        .with_overlap(["Condition A", "Condition C"], 90)
        .with_overlap(["Condition A", "Condition D"], 70)
        .with_overlap(["Condition B", "Condition C"], 100)
        .with_overlap(["Condition B", "Condition D"], 80)
        .with_overlap(["Condition C", "Condition D"], 60)
        .with_overlap(["Condition A", "Condition B", "Condition C"], 35)
        .with_overlap(["Condition A", "Condition B", "Condition D"], 25)
        .with_overlap(["Condition A", "Condition C", "Condition D"], 20)
        .with_overlap(["Condition B", "Condition C", "Condition D"], 30)
        .with_overlap(
            ["Condition A", "Condition B", "Condition C", "Condition D"],
            10,
        )
        .with_counts(true)
        .with_legend("Conditions");
    let plots = vec![Plot::Venn(venn)];
    let layout = Layout::auto_from_plots(&plots).with_title("4-Set Venn Diagram");
    write("four_set", plots, layout);
    println!("  four_set");
}