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
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

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

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

fn sample_times() -> (Vec<f64>, Vec<bool>) {
    let times = vec![
        1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0,
        17.0, 18.0, 19.0, 20.0,
    ];
    let events = vec![
        true, true, false, true, true, false, true, false, true, false, true, false, true, false,
        false, true, false, true, false, true,
    ];
    (times, events)
}

#[test]
fn test_survival_basic() {
    let (times, events) = sample_times();
    let sp = SurvivalPlot::new().with_group("All patients", times, events);
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Kaplan-Meier")
        .with_x_label("Time (months)")
        .with_y_label("Survival probability");
    let svg = write_svg("survival_basic", plots, layout);
    // KM step function is a path
    assert!(svg.contains("<path"));
}

#[test]
fn test_survival_two_groups() {
    let sp = SurvivalPlot::new()
        .with_group(
            "Control",
            vec![2.0, 4.0, 6.0, 8.0, 10.0, 12.0, 14.0, 16.0, 18.0, 20.0],
            vec![
                true, true, true, false, true, false, true, false, false, true,
            ],
        )
        .with_group(
            "Treatment",
            vec![3.0, 7.0, 9.0, 12.0, 15.0, 18.0, 20.0, 22.0, 24.0, 26.0],
            vec![
                true, false, true, false, true, false, false, true, false, false,
            ],
        )
        .with_legend("Group");
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Two-group KM")
        .with_x_label("Time (months)")
        .with_y_label("Survival probability");
    let svg = write_svg("survival_two_groups", plots, layout);
    assert!(svg.contains("Control"));
    assert!(svg.contains("Treatment"));
}

#[test]
fn test_survival_with_ci() {
    let (times, events) = sample_times();
    let sp = SurvivalPlot::new()
        .with_group("Patients", times, events)
        .with_ci(true)
        .with_ci_alpha(0.2);
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots).with_title("KM with CI");
    write_svg("survival_ci", plots, layout);
}

#[test]
fn test_survival_no_censoring_marks() {
    let (times, events) = sample_times();
    let sp = SurvivalPlot::new()
        .with_group("Patients", times, events)
        .with_censoring(false);
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots).with_title("No censoring marks");
    write_svg("survival_no_censoring", plots, layout);
}

#[test]
fn test_survival_pvalue_annotation() {
    let sp = SurvivalPlot::new()
        .with_group(
            "Control",
            vec![2.0, 4.0, 6.0, 9.0, 12.0],
            vec![true, true, false, true, false],
        )
        .with_group(
            "Treatment",
            vec![4.0, 8.0, 12.0, 16.0, 20.0],
            vec![true, false, true, false, false],
        )
        .with_pvalue_text("log-rank p = 0.023")
        .with_legend("Group");
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots).with_title("KM with p-value");
    let svg = write_svg("survival_pvalue", plots, layout);
    assert!(svg.contains("p = 0.023"));
}

#[test]
fn test_survival_three_groups() {
    let sp = SurvivalPlot::new()
        .with_group(
            "Stage I",
            vec![8.0, 12.0, 18.0, 24.0, 30.0],
            vec![false, true, false, false, true],
        )
        .with_group(
            "Stage II",
            vec![5.0, 8.0, 12.0, 15.0, 20.0],
            vec![true, true, false, true, false],
        )
        .with_group(
            "Stage III",
            vec![2.0, 4.0, 6.0, 9.0, 12.0],
            vec![true, true, true, false, true],
        )
        .with_legend("Stage");
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Survival by stage")
        .with_x_label("Time (months)")
        .with_y_label("Overall survival");
    let svg = write_svg("survival_three_groups", plots, layout);
    assert!(svg.contains("Stage I"));
    assert!(svg.contains("Stage III"));
}

#[test]
fn test_survival_all_events() {
    // No censored observations
    let sp = SurvivalPlot::new().with_group(
        "All events",
        vec![1.0, 2.0, 3.0, 4.0, 5.0],
        vec![true, true, true, true, true],
    );
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots).with_title("All events");
    write_svg("survival_all_events", plots, layout);
}

#[test]
fn test_survival_all_censored() {
    // All censored — flat curve at 1.0
    let sp = SurvivalPlot::new().with_group(
        "All censored",
        vec![5.0, 10.0, 15.0],
        vec![false, false, false],
    );
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots).with_title("All censored");
    write_svg("survival_all_censored", plots, layout);
}

#[test]
fn test_survival_single_event() {
    let sp = SurvivalPlot::new().with_group(
        "One event",
        vec![5.0, 10.0, 15.0],
        vec![false, true, false],
    );
    assert!(Plot::Survival(sp).bounds().is_some());
}

#[test]
fn test_survival_empty_no_panic() {
    let sp = SurvivalPlot::new();
    assert!(Plot::Survival(sp).bounds().is_none());
}

#[test]
fn test_survival_colored_groups() {
    let sp = SurvivalPlot::new()
        .with_colored_group(
            "Control",
            vec![2.0, 5.0, 8.0, 12.0, 16.0],
            vec![true, false, true, false, true],
            "tomato",
        )
        .with_colored_group(
            "Treatment",
            vec![4.0, 8.0, 12.0, 18.0, 24.0],
            vec![true, false, false, true, false],
            "seagreen",
        )
        .with_ci(true)
        .with_legend("Group");
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots).with_title("Colored groups + CI");
    write_svg("survival_colored_ci", plots, layout);
}

#[test]
fn test_survival_realistic_os() {
    // 40-patient simulated OS dataset, two arms
    let ctrl_times = vec![
        1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 14.0, 15.0, 16.0, 18.0,
        20.0, 22.0, 24.0, 26.0,
    ];
    let ctrl_events = vec![
        true, true, true, false, true, true, false, true, false, true, true, false, true, false,
        false, true, false, true, false, false,
    ];
    let trt_times = vec![
        2.0, 4.0, 6.0, 8.0, 10.0, 12.0, 14.0, 16.0, 18.0, 20.0, 22.0, 24.0, 26.0, 28.0, 30.0, 32.0,
        34.0, 36.0, 40.0, 42.0,
    ];
    let trt_events = vec![
        false, true, false, true, false, false, true, false, false, true, false, false, true,
        false, false, true, false, false, false, true,
    ];
    let sp = SurvivalPlot::new()
        .with_group("Control (n=20)", ctrl_times, ctrl_events)
        .with_group("Treatment (n=20)", trt_times, trt_events)
        .with_ci(true)
        .with_pvalue_text("log-rank p = 0.041")
        .with_legend("Arm");
    let plots = vec![Plot::Survival(sp)];
    let layout = Layout::auto_from_plots(&plots)
        .with_title("Overall Survival")
        .with_x_label("Time (months)")
        .with_y_label("Probability of survival")
        .with_width(520.0)
        .with_height(400.0);
    let svg = write_svg("survival_realistic_os", plots, layout);
    assert!(svg.contains("Control"));
    assert!(svg.contains("Treatment"));
    assert!(svg.contains("p = 0.041"));
}