5个版本 (重大变更)
0.5.0 | 2024年5月8日 |
---|---|
0.4.0 | 2024年4月4日 |
0.3.0 | 2024年1月25日 |
0.2.0 | 2023年12月14日 |
0.1.0 | 2023年8月3日 |
#266 在 生物学 中
每月336 次下载
用于 noodles
41KB
875 行
noodles
noodles 尝试提供符合规范(适用时)的库的实现,用于处理各种生物信息学文件格式。它目前支持BAM 1.6、BCF 2.2、BED、BGZF、CRAM 3.0/3.1、CSI、FASTA、FASTQ、GFF3、GTF 2.2、htsget 1.3、refget 2.0、SAM 1.6、tabix和VCF 4.3/4.4。
使用方法
noodles 发布在 crates.io。早期版本可用于项目,但请注意,API仍被视为实验性的。
noodles 根据文件格式分为多个crate。为了方便,可以将名为 noodles
的顶级元crate添加到项目的依赖列表中;并将格式作为 功能。例如,要使用BAM格式,添加 noodles
crate并启用 bam
功能。
cargo add noodles --features bam
然后可以通过其重导出的名称导入每个启用的功能,例如
use noodles::bam;
功能标志
单个crate可能有可选的功能,可以使用功能标志启用。
async
:启用使用 Tokio 的异步I/O。 (BAM、BCF、BGZF、CRAM、CSI、FASTA、FASTQ、GFF、SAM、tabix和VCF)libdeflate
:使用 libdeflate 对DEFLATE流进行编码和解码。 (BGZF和CRAM)
示例
每个crate可能都有自己的示例目录,所有示例都可以作为应用程序运行。克隆仓库后,运行 cargo run --release --example
以列出可用的示例。使用示例名称作为选项参数,并将程序参数追加到命令中,例如
cargo run --release --example bam_write > sample.bam
cargo run --release --example bam_read_header sample.bam
lib.rs
:
noodles-refget 是一个refget 2.0客户端。
依赖项
~4–15MB
~213K SLoC