#vcf #genomics #bioinformatics #command-line-tool #file-path

bin+lib spdi

SPDI 是一种描述基因组变异的格式。此包提供了一个库,用于获取变异的 SPDI 格式表示,以及一个命令行工具,可以将 SPDI 格式输出添加到输入 VCF 文件中。

3 个版本

0.1.3 2024 年 2 月 5 日
0.1.1 2024 年 2 月 4 日
0.1.0 2024 年 2 月 4 日

#174生物学

自定义许可

57KB
1K SLoC

SPDI 是一个用于获取基因组变异 SPDI 格式表示的 Rust 库和命令行工具。

作为命令行工具

git clone [email protected]:rkimoakbioinformatics/spdi.git
cd spdi
cargo build --release
# Add SPDI representation as OV_SPDI_IDS field in INFO of a VCF file.
./target/release/spdi -t <2bit file path> -f <VCF file path> 1>out.vcf 2>err.txt
# Get SPDI representation of a single variant.
./target/release/spdi -t <2bit file path> -v chr1:99092:C:CT

作为库

要添加

cargo add spdi
cargo add anyhow

要使用

use anyhow::Result;

fn example() -> Result<String> {
    let s = spdi::SPDI::new("path/to/2bit/file")?;
    let spdi_string = s.get_spdi_string("chr1", 99092, "C", "CT")?;
    println!("{}", spdi_string);
}

lib.rs:

示例

use anyhow::Result;

fn example() -> Result<String> {
    let s = spdi::SPDI::new("path/to/2bit/file")?;
    let spdi_string = s.get_spdi_string("chr1", 99092, "C", "CT")?;
    println!("{}", spdi_string);
}

依赖项

~6MB
~109K SLoC