#生物信息学 #持续集成 #领域 #测试 #文档 #遵循

bio

Rust的生物信息学库。此库提供许多对生物信息学有用的算法和数据结构实现,但也适用于其他领域。

90个版本 (10个稳定版)

2.0.1 2024年7月22日
1.6.0 2024年3月26日
1.5.0 2023年12月9日
1.4.0 2023年9月12日
0.3.0 2015年3月19日

数据结构 中排名 65

Download history 1561/week @ 2024-05-03 1599/week @ 2024-05-10 1762/week @ 2024-05-17 1506/week @ 2024-05-24 1694/week @ 2024-05-31 1815/week @ 2024-06-07 1979/week @ 2024-06-14 1753/week @ 2024-06-21 1256/week @ 2024-06-28 1232/week @ 2024-07-05 1445/week @ 2024-07-12 1718/week @ 2024-07-19 1817/week @ 2024-07-26 2855/week @ 2024-08-02 2813/week @ 2024-08-09 2590/week @ 2024-08-16

每月下载量 10,373
102 个crate中使用(91个直接使用)

MIT 许可证

1MB
19K SLoC

Crates.io Crates.io Crates.io GitHub Workflow Status Coveralls DOI

Rust-Bio logo Rust-Bio,Rust的生物信息学库。

此库提供了对生物信息学有用的算法和数据结构的Rust实现。所有提供实现都通过持续集成进行了严格测试。

请参阅API文档以了解功能和用法示例。

在使用Rust-Bio时,请引用以下文章

Köster, J. (2016). Rust-Bio: 一个快速且安全的生物信息学库。生物信息学,32(3),444-446。

此外,您可以通过DOI引用所使用的版本

Rust-Bio: DOI

贡献

欢迎任何形式的贡献,从简单的错误报告到全新的模块

如果您发现了一个错误但没有时间或深入的知识去修复它,只需检查是否可以向现有问题添加信息,否则尽可能多地提供信息提交错误报告。如果您想贡献修复、文档或新代码,欢迎提交拉取请求。在提交之前,首先安装pre-commit以避免由于格式等问题导致的连续集成构建失败。

  1. 安装pre-commit(见pre-commit.com/#installation
  2. 在rust-bio基本目录下运行pre-commit install

根据您打算贡献的频率,您有两种方式可以打开拉取请求

  1. 对于一次性贡献,只需分叉存储库,将您的更改应用到您分叉中的分支,然后打开一个拉取请求。
  2. 如果您打算多次贡献,通过在rust-bio Discord服务器打招呼成为贡献者,一起用简短的句子说明您是谁,并提到您想要贡献什么。我们会将您加入团队。然后,您不需要创建分叉,但可以将新分支推送到主存储库并在那里打开拉取请求。

如果您想贡献但不知道从哪里开始,请查看路线图

文档指南

每个公共函数和模块都应该有文档注释。查看在哪里使用哪些类型的注释。在rust-bio中,文档注释应该

  • 解释功能
  • 提供至少一个有用的使用示例(最好是doctests,在测试期间运行,并使用描述性的expect()语句来处理可能发生的任何Err()
  • 描述(适用时)的时间和内存复杂度
  • 引用和链接数据结构、算法或代码的来源和解释(适用时)

作为额外加分项,您可以熟悉以下内容

最低支持的Rust版本

目前最低支持的Rust版本是1.65.0。

许可证

在MIT许可证下许可http://opensource.org/licenses/MIT。本项目的复制、修改或分发不得违反这些条款。

依赖项

~17MB
~290K SLoC