bustools 0.13.1

Interacting with the kallisto/bus format of scRNAseq data
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

# Rustbustools

Rust library to interact with the kallisto/bus format of scRNAseq data (see [bustools](https://github.com/BUStools/bustools)).
At this point, it's **far from complete and correct**, but rather a project to learn rust.

There's also a CLI mimicking [bustools](https://github.com/BUStools/bustools), see [bustools_cli](https://github.com/redst4r/bustools_cli-rs)
## Examples
For more examples, see the rust-docs.

### Iterating a bus file
```rust
use bustools::io::{BusReader};
let bus = BusReader::new("/tmp/some.bus");
for record in bus {
    // record.CB, record.UMI ...
}
```

### Iterating a bus file by cell
```rust
use bustools::io::BusReader;
use bustools::iterators::CellGroupIterator; //need to bring that trait into scope

let breader = BusReader::new("/path/to/some.bus");
for (cb, vector_of_records) in breader.groupby_cb() {
    // Example: the number of records in that cell
    let n_molecules: usize = vector_of_records.len();
}
```

## TODO
- [ ] consolidate bus_multi and merger