kuva 0.1.3

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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

use kuva::plot::{DotPlot, ColorMap};
use kuva::backend::svg::SvgBackend;
use kuva::render::render::render_multiple;
use kuva::render::layout::Layout;
use kuva::render::plots::Plot;

#[test]
fn test_dot_basic() {
    // 3 genes x 3 cell types, default Viridis colormap
    let data = vec![
        ("CellTypeA", "GeneX", 80.0_f64, 2.5_f64),
        ("CellTypeA", "GeneY", 60.0, 1.8),
        ("CellTypeA", "GeneZ", 40.0, 1.2),
        ("CellTypeB", "GeneX", 50.0, 3.1),
        ("CellTypeB", "GeneY", 90.0, 2.9),
        ("CellTypeB", "GeneZ", 70.0, 2.0),
        ("CellTypeC", "GeneX", 30.0, 0.9),
        ("CellTypeC", "GeneY", 45.0, 1.4),
        ("CellTypeC", "GeneZ", 55.0, 1.7),
    ];

    let dot = DotPlot::new().with_data(data);
    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Dot Plot Basic")
        .with_x_label("Cell Type")
        .with_y_label("Gene");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_basic.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    assert!(svg.contains("<circle"));
}

#[test]
fn test_dot_matrix() {
    // Dense matrix input
    let x_cats = vec!["TypeA", "TypeB", "TypeC"];
    let y_cats = vec!["Gene1", "Gene2", "Gene3"];
    let sizes = vec![
        vec![80.0_f64, 50.0, 30.0],
        vec![60.0, 90.0, 45.0],
        vec![40.0, 70.0, 55.0],
    ];
    let colors = vec![
        vec![2.5_f64, 3.1, 0.9],
        vec![1.8, 2.9, 1.4],
        vec![1.2, 2.0, 1.7],
    ];

    let dot = DotPlot::new().with_matrix(x_cats, y_cats, sizes, colors);
    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots).with_title("Dot Plot Matrix Input");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_matrix.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    // 9 circles for a 3x3 matrix
    assert_eq!(svg.matches("<circle").count(), 9);
}

#[test]
fn test_dot_custom_colormap() {
    let data = vec![
        ("A", "G1", 70.0_f64, 3.0_f64),
        ("A", "G2", 50.0, 1.5),
        ("B", "G1", 40.0, 2.0),
        ("B", "G2", 80.0, 4.0),
    ];

    let dot = DotPlot::new()
        .with_data(data)
        .with_color_map(ColorMap::Inferno);

    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots).with_title("Dot Plot Inferno");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_custom_colormap.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    assert!(svg.contains("<circle"));
}

#[test]
fn test_dot_size_range() {
    // Explicit size range clamp
    let data = vec![
        ("CT1", "G1", 20.0_f64, 1.0_f64),
        ("CT1", "G2", 50.0, 2.0),
        ("CT2", "G1", 80.0, 3.0),
        ("CT2", "G2", 110.0, 4.0),  // will be clamped to 100
    ];

    let dot = DotPlot::new()
        .with_data(data)
        .with_size_range(0.0, 100.0);

    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots).with_title("Dot Plot Size Range");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_size_range.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    assert!(svg.contains("<circle"));
}

#[test]
fn test_dot_color_range() {
    // Explicit color range clamp
    let data = vec![
        ("CT1", "G1", 50.0_f64, 0.5_f64),
        ("CT1", "G2", 70.0, 3.0),
        ("CT2", "G1", 40.0, 5.5),  // will be clamped to 5
        ("CT2", "G2", 90.0, 2.0),
    ];

    let dot = DotPlot::new()
        .with_data(data)
        .with_color_range(0.0, 5.0);

    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots).with_title("Dot Plot Color Range");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_color_range.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    assert!(svg.contains("<circle"));
}

#[test]
fn test_dot_size_legend() {
    let data = vec![
        ("TypeA", "GeneX", 25.0_f64, 1.0_f64),
        ("TypeA", "GeneY", 75.0, 2.0),
        ("TypeB", "GeneX", 50.0, 3.0),
        ("TypeB", "GeneY", 100.0, 4.0),
    ];

    let dot = DotPlot::new()
        .with_data(data)
        .with_size_legend("% Expressing");

    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Dot Plot Size Legend");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_size_legend.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    // Should have legend entries
    assert!(svg.contains("25.0") || svg.contains("100.0"));
}

#[test]
fn test_dot_colorbar() {
    let data = vec![
        ("TypeA", "GeneX", 80.0_f64, 2.5_f64),
        ("TypeA", "GeneY", 60.0, 1.8),
        ("TypeB", "GeneX", 50.0, 3.1),
        ("TypeB", "GeneY", 90.0, 2.9),
    ];

    let dot = DotPlot::new()
        .with_data(data)
        .with_colorbar("Mean expression");

    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Dot Plot Colorbar");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_colorbar.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    // Colorbar draws many rects
    assert!(svg.contains("<rect"));
}

#[test]
fn test_dot_both_legends() {
    let data = vec![
        ("TypeA", "GeneX", 80.0_f64, 2.5_f64),
        ("TypeA", "GeneY", 60.0, 1.8),
        ("TypeA", "GeneZ", 40.0, 1.2),
        ("TypeB", "GeneX", 50.0, 3.1),
        ("TypeB", "GeneY", 90.0, 2.9),
        ("TypeB", "GeneZ", 70.0, 2.0),
    ];

    let dot = DotPlot::new()
        .with_data(data)
        .with_size_legend("% Expressing")
        .with_colorbar("Mean expression");

    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Dot Plot: Size Legend + Colorbar");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_both_legends.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    assert!(svg.contains("<circle"));
    assert!(svg.contains("<rect"));
}

#[test]
fn test_dot_sparse() {
    // Some (x, y) pairs are absent — fewer circles than grid cells
    let data = vec![
        ("TypeA", "GeneX", 80.0_f64, 2.5_f64),
        // ("TypeA", "GeneY", ...) missing
        ("TypeA", "GeneZ", 40.0, 1.2),
        // ("TypeB", "GeneX", ...) missing
        ("TypeB", "GeneY", 90.0, 2.9),
        ("TypeB", "GeneZ", 70.0, 2.0),
        ("TypeC", "GeneX", 30.0, 0.9),
        // ("TypeC", "GeneY", ...) missing
        // ("TypeC", "GeneZ", ...) missing
    ];

    let dot = DotPlot::new().with_data(data);
    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots).with_title("Dot Plot Sparse");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_sparse.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    // Only 5 circles (not 9 for a 3x3 grid)
    assert_eq!(svg.matches("<circle").count(), 5);
}

#[test]
fn test_dot_large() {
    // 50 genes x 10 cell types
    let cell_types: Vec<String> = (0..10).map(|i| format!("CellType{}", i)).collect();
    let genes: Vec<String> = (0..50).map(|i| format!("Gene{:02}", i)).collect();

    let mut data = Vec::new();
    for (gi, gene) in genes.iter().enumerate() {
        for (ci, cell) in cell_types.iter().enumerate() {
            let size = ((gi * 2 + ci * 3) % 100) as f64;
            let color = ((gi + ci * 5) % 50) as f64 / 10.0;
            data.push((cell.as_str(), gene.as_str(), size, color));
        }
    }

    let dot = DotPlot::new()
        .with_data(data)
        .with_size_legend("% Expressing")
        .with_colorbar("Mean expression");

    let plots = vec![Plot::DotPlot(dot)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Dot Plot Large (50 genes × 10 cell types)")
        .with_x_label("Cell Type")
        .with_y_label("Gene");

    let scene = render_multiple(plots, layout);
    let svg = SvgBackend.render_scene(&scene);
    std::fs::write("test_outputs/dot_large.svg", svg.clone()).unwrap();

    assert!(svg.contains("<svg"));
    // 500 circles for 50x10
    assert_eq!(svg.matches("<circle").count(), 504); // 500 data + 4 legend
}