Somalier 开源项目使用教程

Somalier 开源项目使用教程

somalierfast sample-swap and relatedness checks on BAMs/CRAMs/VCFs/GVCFs... "like damn that is one smart wine guy"项目地址:https://gitcode.com/gh_mirrors/so/somalier

1. 项目的目录结构及介绍

Somalier 项目的目录结构如下：

somalier/
├── docs/
├── scripts/
├── src/
├── tests/
├── .gitignore
├── CHANGES.md
├── CITATION.cff
├── LICENSE
├── README.md
├── nim.cfg
├── paper-cmd.sh
├── paper-expected-groups
├── results.html
├── somalier.nimble
├── style.css

目录介绍

• docs/: 包含项目的文档文件。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的源代码文件。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• CHANGES.md: 项目变更日志。
• CITATION.cff: 项目引用信息。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• nim.cfg: Nim 语言配置文件。
• paper-cmd.sh: 论文相关命令脚本。
• paper-expected-groups: 论文预期分组文件。
• results.html: 结果展示网页文件。
• somalier.nimble: Nimble 包管理文件。
• style.css: 样式表文件。

2. 项目的启动文件介绍

Somalier 项目的启动文件是 somalier 可执行文件。该文件是通过编译 src/ 目录下的源代码生成的。启动文件的主要功能包括：

• 提取信息站点
• 评估样本间的亲缘关系
• 执行质量控制

启动文件的使用方法如下：

./somalier extract -d cohort/ --sites sites.hg38.vcf.gz -f $reference $sample.bam
./somalier relate -i extracted/

3. 项目的配置文件介绍

Somalier 项目的主要配置文件包括：

• nim.cfg: Nim 语言的配置文件，用于指定编译选项和依赖项。
• somalier.nimble: Nimble 包管理文件，用于管理项目的依赖和版本信息。

nim.cfg 配置文件

该文件包含 Nim 编译器的配置选项，例如：

cc = "gcc"
debug = true

somalier.nimble 配置文件

该文件定义了项目的名称、版本、依赖等信息，例如：

version = "0.0.1"
author = "Brent S. Pedersen"
description = "Somalier: extract informative sites, evaluate relatedness, and perform quality-control on BAM/CRAM/BCF/VCF/GVCF"
license = "MIT"
srcDir = "src"
bin = @["somalier"]

通过以上配置文件，用户可以自定义编译和运行 Somalier 项目的行为。

somalierfast sample-swap and relatedness checks on BAMs/CRAMs/VCFs/GVCFs... "like damn that is one smart wine guy"项目地址:https://gitcode.com/gh_mirrors/so/somalier