77 次重大发布

0.79.0 2024年8月4日
0.78.0 2024年7月14日
0.77.0 2024年6月17日
0.67.0 2024年3月28日
0.3.0 2021年7月30日

#9生物学

Download history 509/week @ 2024-05-04 825/week @ 2024-05-11 1517/week @ 2024-05-18 1069/week @ 2024-05-25 677/week @ 2024-06-01 655/week @ 2024-06-08 1669/week @ 2024-06-15 964/week @ 2024-06-22 342/week @ 2024-06-29 446/week @ 2024-07-06 1190/week @ 2024-07-13 835/week @ 2024-07-20 713/week @ 2024-07-27 2336/week @ 2024-08-03 1327/week @ 2024-08-10 1474/week @ 2024-08-17

5,959 每月下载量
57crate(47 个直接)中使用

MIT 许可证

1MB
20K 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;并且格式,列在 功能 中。例如,要处理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

依赖项

~0–11MB
~113K SLoC