6 个版本 (破坏性更新)
0.6.0 | 2024年5月8日 |
---|---|
0.5.0 | 2024年4月4日 |
0.4.0 | 2024年1月25日 |
0.3.0 | 2023年12月14日 |
0.1.0 | 2023年4月6日 |
#283 in 生物学
每月60 次下载
在 noodles 中使用
50KB
1K SLoC
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。为了方便,可以将顶层元crate(名为 noodles
)添加到项目的依赖列表中;格式,列在 功能 中。例如,要使用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-htsget 是一个 htsget 1.3 客户端。
依赖关系
~4–18MB
~224K SLoC