49 次重大发布

新增 0.50.0 2024年8月4日
0.49.0 2024年7月14日
0.48.0 2024年6月17日
0.39.0 2024年3月28日
0.3.1 2022年11月29日

#2#bgzf

Download history • Rust 包仓库 88/week @ 2024-04-16 • Rust 包仓库 46/week @ 2024-04-23 • Rust 包仓库 170/week @ 2024-04-30 • Rust 包仓库 122/week @ 2024-05-07 • Rust 包仓库 152/week @ 2024-05-14 • Rust 包仓库 35/week @ 2024-05-21 • Rust 包仓库 154/week @ 2024-05-28 • Rust 包仓库 168/week @ 2024-06-04 • Rust 包仓库 96/week @ 2024-06-11 • Rust 包仓库 61/week @ 2024-06-18 • Rust 包仓库 9/week @ 2024-07-02 • Rust 包仓库 139/week @ 2024-07-09 • Rust 包仓库 27/week @ 2024-07-16 • Rust 包仓库 77/week @ 2024-07-30 • Rust 包仓库

245 每月下载量
用于 3 crates

MIT 许可证

795KB
19K SLoC

noodles

crates.io Docs.rs CI status

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 添加到项目的依赖列表中;并且格式,列出为 features。例如,要使用 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-util 是用于处理 noodles 的实用工具。

依赖项

~0.3–2.5MB
~43K SLoC