#write #parse #path #file-path #cluster #read #binary

bin+lib clstr

A library to parse and write .clstr files from 'CD-HIT', as well as a small binary with simple functionality

1 unstable release

0.1.1 Oct 30, 2024

#222 in Science

Download history 110/week @ 2024-10-28 18/week @ 2024-11-04

128 downloads per month

MIT license

25KB
521 lines

clstr

A small crate to parse and write .clstr files.

API

A really simple example which just reads in a file and prints it.

use std::fs::File;
use std::io::{BufReader, BufWriter};
use std::path::Path;

fn main() -> Result<(), std::error::Error> {
    // Define the input and output file paths
    let input_path = Path::new("input.clstr");
    let output_path = Path::new("output.clstr");

    // make the parser
    let parser = clstr::from_path(input_path)?;

    // and the writer
    let clstr_writer = clstr::to_path(output_path)?;

    for cluster_res in parser {
      let cluster = cluster_res?;
      clstr_writer.write_cluster(&cluster)?;
    }

    clstr_writer.flush()?;

    Ok(())
}

Binaries

There are two programs clstr topn and clstr tofasta which are used in vscan.


lib.rs:

A small crate to parse CD-HIT's .clstr file format. Only tested with CD-HIT, not CD-HIT-EST. Or actually another program in the cd-hit suite.

Dependencies

~19MB
~327K SLoC