fgumi 0.2.0

High-performance tools for UMI-tagged sequencing data: extraction, grouping, and consensus calling
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

//! Integration tests for simulate command template-coordinate sorting.
//!
//! These tests verify that the simulated BAM files are properly sorted
//! in template-coordinate order, matching `samtools sort --template-coordinate`.

use std::process::Command;
use tempfile::TempDir;

/// Check if samtools is available in PATH.
fn samtools_available() -> bool {
    Command::new("samtools").arg("--version").output().map(|o| o.status.success()).unwrap_or(false)
}

/// Check if fgumi binary is built with simulate feature.
fn fgumi_simulate_available() -> bool {
    let output = Command::new("cargo")
        .args(["build", "--features", "simulate", "--message-format=short"])
        .output();
    output.map(|o| o.status.success()).unwrap_or(false)
}

/// Run samtools sort --template-coordinate and compare with original.
/// Returns true if the files are identical (original is already sorted).
fn verify_template_coordinate_sorted(bam_path: &std::path::Path) -> bool {
    let temp_dir = TempDir::new().unwrap();
    let sorted_path = temp_dir.path().join("sorted.bam");

    // Sort with samtools
    let status = Command::new("samtools")
        .args([
            "sort",
            "--template-coordinate",
            "-o",
            sorted_path.to_str().unwrap(),
            bam_path.to_str().unwrap(),
        ])
        .status()
        .expect("Failed to run samtools sort");

    if !status.success() {
        return false;
    }

    // Extract read names and positions from both files
    let original = Command::new("samtools")
        .args(["view", bam_path.to_str().unwrap()])
        .output()
        .expect("Failed to read original BAM");

    let sorted = Command::new("samtools")
        .args(["view", sorted_path.to_str().unwrap()])
        .output()
        .expect("Failed to read sorted BAM");

    // Compare outputs
    original.stdout == sorted.stdout
}

/// Test that mapped-reads produces template-coordinate sorted output.
#[test]
#[ignore = "requires samtools and fgumi with simulate feature"]
fn test_mapped_reads_matches_samtools() {
    if !samtools_available() {
        eprintln!("Skipping: samtools not available");
        return;
    }
    if !fgumi_simulate_available() {
        eprintln!("Skipping: fgumi simulate feature not available");
        return;
    }

    let temp_dir = TempDir::new().unwrap();
    let bam_path = temp_dir.path().join("mapped.bam");
    let truth_path = temp_dir.path().join("truth.tsv");

    // Generate mapped reads
    let status = Command::new("cargo")
        .args([
            "run",
            "--features",
            "simulate",
            "--release",
            "--",
            "simulate",
            "mapped-reads",
            "-o",
            bam_path.to_str().unwrap(),
            "--truth",
            truth_path.to_str().unwrap(),
            "--num-molecules",
            "1000",
            "--seed",
            "42",
        ])
        .status()
        .expect("Failed to run fgumi simulate mapped-reads");

    assert!(status.success(), "fgumi simulate mapped-reads failed");
    assert!(bam_path.exists(), "BAM file not created");

    // Verify sort order matches samtools
    assert!(
        verify_template_coordinate_sorted(&bam_path),
        "mapped-reads output does not match samtools sort --template-coordinate"
    );
}

/// Test that grouped-reads (simplex) produces template-coordinate sorted output.
#[test]
#[ignore = "requires samtools and fgumi with simulate feature"]
fn test_grouped_reads_simplex_matches_samtools() {
    if !samtools_available() {
        eprintln!("Skipping: samtools not available");
        return;
    }
    if !fgumi_simulate_available() {
        eprintln!("Skipping: fgumi simulate feature not available");
        return;
    }

    let temp_dir = TempDir::new().unwrap();
    let bam_path = temp_dir.path().join("grouped.bam");
    let truth_path = temp_dir.path().join("truth.tsv");

    // Generate grouped reads (simplex)
    let status = Command::new("cargo")
        .args([
            "run",
            "--features",
            "simulate",
            "--release",
            "--",
            "simulate",
            "grouped-reads",
            "-o",
            bam_path.to_str().unwrap(),
            "--truth",
            truth_path.to_str().unwrap(),
            "--num-molecules",
            "1000",
            "--seed",
            "42",
        ])
        .status()
        .expect("Failed to run fgumi simulate grouped-reads");

    assert!(status.success(), "fgumi simulate grouped-reads failed");
    assert!(bam_path.exists(), "BAM file not created");

    // Verify sort order matches samtools
    assert!(
        verify_template_coordinate_sorted(&bam_path),
        "grouped-reads simplex output does not match samtools sort --template-coordinate"
    );
}

/// Test that grouped-reads (duplex) produces template-coordinate sorted output.
#[test]
#[ignore = "requires samtools and fgumi with simulate feature"]
fn test_grouped_reads_duplex_matches_samtools() {
    if !samtools_available() {
        eprintln!("Skipping: samtools not available");
        return;
    }
    if !fgumi_simulate_available() {
        eprintln!("Skipping: fgumi simulate feature not available");
        return;
    }

    let temp_dir = TempDir::new().unwrap();
    let bam_path = temp_dir.path().join("grouped_duplex.bam");
    let truth_path = temp_dir.path().join("truth.tsv");

    // Generate grouped reads (duplex)
    let status = Command::new("cargo")
        .args([
            "run",
            "--features",
            "simulate",
            "--release",
            "--",
            "simulate",
            "grouped-reads",
            "-o",
            bam_path.to_str().unwrap(),
            "--truth",
            truth_path.to_str().unwrap(),
            "--num-molecules",
            "1000",
            "--duplex",
            "--seed",
            "42",
        ])
        .status()
        .expect("Failed to run fgumi simulate grouped-reads --duplex");

    assert!(status.success(), "fgumi simulate grouped-reads --duplex failed");
    assert!(bam_path.exists(), "BAM file not created");

    // Verify sort order matches samtools
    assert!(
        verify_template_coordinate_sorted(&bam_path),
        "grouped-reads duplex output does not match samtools sort --template-coordinate"
    );
}

/// Test with larger dataset to catch edge cases.
#[test]
#[ignore = "requires samtools and fgumi with simulate feature; slow"]
fn test_large_dataset_matches_samtools() {
    if !samtools_available() {
        eprintln!("Skipping: samtools not available");
        return;
    }
    if !fgumi_simulate_available() {
        eprintln!("Skipping: fgumi simulate feature not available");
        return;
    }

    let temp_dir = TempDir::new().unwrap();
    let bam_path = temp_dir.path().join("large.bam");
    let truth_path = temp_dir.path().join("truth.tsv");

    // Generate larger dataset to catch edge cases
    let status = Command::new("cargo")
        .args([
            "run",
            "--features",
            "simulate",
            "--release",
            "--",
            "simulate",
            "grouped-reads",
            "-o",
            bam_path.to_str().unwrap(),
            "--truth",
            truth_path.to_str().unwrap(),
            "--num-molecules",
            "10000",
            "--duplex",
            "--seed",
            "12345",
        ])
        .status()
        .expect("Failed to run fgumi simulate grouped-reads");

    assert!(status.success());
    assert!(verify_template_coordinate_sorted(&bam_path));
}