Rust 生物信息学工具箱 (rboss)

Rust 生物信息学工具箱（rboss），是一个设计用于简化生物信息学文件操作的命令行工具。它提供了一系列命令来操作生物信息学中常用的序列数据文件，如 BAM、FASTA 和 FASTQ 格式。

最低支持 Rust 版本 (MSRV)

此项目遵循最低支持 Rust 版本 (MSRV) 政策。最低支持 Rust 版本 (MSRV) 是 1.70.0。我们确保项目中的所有代码都与这个版本或更新的版本兼容，以保持稳定性和兼容性。

特性

• 高性能：利用 Rust 的性能进行重计算任务。
• 安全性：Rust 强大的类型系统和所有权模型确保生物信息学操作的安全性。
• 并发性：利用 Rust 的现代并发工具进行并行数据处理。

安装

您可以使用 Cargo（Rust 包管理器）安装 rboss。确保您的系统上已安装 Rust 和 Cargo，然后运行

cargo install rboss

入门

要开始使用 rboss，您可以使用以下语法调用它

rboss [OPTIONS] [COMMAND]

rboss 提供了多个命令以执行不同的操作

命令

• extract（别名：e）：从 BAM 文件中提取读取。

  用法

  rboss extract [OPTIONS] <BAM_FILE>
  

• index：索引 BAM 文件以加快读取访问。

  用法

  rboss index <BAM_FILE>
  

• fa2fq：将 FASTA 文件转换为 FASTQ 格式。

  用法

  rboss fa2fq <FASTA_FILE>
  

• fq2fa：将 FASTQ 文件转换为 FASTA 格式。

  用法

  rboss fq2fa <FASTQ_FILE>
  

• rsoft：在目录中递归地创建具有相同后缀的文件的软链接。

  用法

  rboss rsoft <TARGET_DIR> -s <SUFFIX>
  

• help：打印 rboss 或其子命令的详细帮助信息。

  用法

  rboss help [COMMAND]
  

选项

• --generate <GENERATOR>：为指定的 shell 生成 rboss 的 shell 完整性。可能的值包括 bash、elvish、fish、powershell 和 zsh。

• -v, --verbose：增加详细程度。此标志出现的次数越多，输出信息越详细。

• -q, --quiet：减少详细程度。此标志出现的次数越多，输出信息越少。

• -h, --help：打印 rboss 及其子命令的帮助信息。

• -V, --version：打印 rboss 的版本信息。

示例

根据 reads.txt 从 BAM 文件中提取读取数据

rboss extract reads.txt sample.bam

索引 BAM 文件

rboss index sample.bam

将 FASTA 文件转换为 FASTQ

rboss fa2fq sample.fasta

将 FASTQ 文件转换为 FASTA

rboss fq2fa sample.fastq

为具有 .txt 或 .csv 后缀的文件创建软链接

rboss rsoft /path/to/directory -s txt csv

要了解任何特定命令的更多信息，可以使用 help 命令

rboss help extract

有关最新更新和更详细的文档，请访问官方 rboss 仓库。

贡献

欢迎为 rboss 做贡献。如果您有改进建议或发现了问题，请在该仓库中打开一个问题或拉取请求。

感谢您使用 rboss，这是一个功能丰富的 Rust 驱动的生物信息学数据操作工具箱！

许可协议

rboss 在 MIT 许可协议和 Apache 许可协议（版本 2.0）的条款下分发。请参阅 LICENSE-APACHE 和 LICENSE-MIT 以获取详细信息。

社区

加入我们讨论 Discord/Gitter/论坛，讨论 rboss 的开发，提出问题，并与其他贡献者合作。

鸣谢

rboss 正在被生物信息学爱好者和 Rust 社区积极开发和维护。我们感谢所有贡献者的努力。