📑️ VCF Batcher

这是一个 Rust 包，用于将 VCF（变体调用文件）切割成较小的批次，旨在用于多进程或分布式计算。

🧰️ 安装

根据您的目标，您可以将此工具作为 CLI 或作为 🦀️ Rust 或 🐍️ Python 中的库使用。

安装 CLI

为了将程序作为 CLI 安装，您需要安装 cargo。 安装 cargo 的说明

安装完成后，您可以在终端中运行以下命令来安装 VCF batcher。

cargo install vcf_batcher

安装 Rust 包

为了将工具作为 Rust 包安装，您可以在 Cargo.toml 依赖项中添加它或运行

cargo add vcf_batcher

您可以在 docs.rs 上找到包文档。

安装 Python 绑定

我们为 VCF batcher 提供了 Python 绑定，可以通过 pip 安装。

pip install vcf-batcher

🪄️ 使用方法

CLI

安装后，您可以通过 vcf_batcher_cli 命令使用 CLI。

vcf_batcher_cli path/to/your_file.vcf path/to/ouput/directory

默认情况下，这将创建每个批次包含 25,000 个样本的批次。如果您想覆盖此默认值，可以通过提供自定义的 --batch-size 或 -b 参数来实现

vcf_batcher_cli -b 1000 path/to/your_file.vcf path/to/ouput/directory

库

安装 rust 包或 python 模块后，您可以使用提供的函数。

🦀️ Rust

pub fn extract_variants_to_batches(
    file_path: &str,
    batch_size: usize,
    output_path: &Path,
    compression_level: Option<Compression>
)

🐍️ Python

vcf_batcher.py_extract_variants_to_batches(
        input_file,
        batches_folder,
        batch_size,
)

许可证

该软件根据 MIT 许可证 许可。