BAMSurgeon 开源项目使用教程

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

BAMSurgeon 是一个用于在现有 BAM 文件中添加突变的工具，主要用于测试突变检测软件。以下是项目的目录结构及其介绍：

bamsurgeon/
├── bin/
│   ├── addindel.py
│   ├── addsnv.py
│   ├── addsv.py
│   └── ...
├── scripts/
│   ├── check_dependencies.py
│   └── ...
├── test_data/
│   ├── test_sv.txt
│   ├── testregion_realign.bam
│   └── ...
├── README.md
└── ...

• bin/：包含主要的可执行脚本，如 addindel.py、addsnv.py 和 addsv.py，用于添加插入缺失、单核苷酸变异和结构变异。
• scripts/：包含辅助脚本，如 check_dependencies.py，用于检查依赖项是否正确安装。
• test_data/：包含测试数据文件，如 test_sv.txt 和 testregion_realign.bam。
• README.md：项目的说明文档，包含安装和使用说明。

2. 项目的启动文件介绍

BAMSurgeon 的主要启动文件位于 bin/ 目录下，包括以下几个关键脚本：

• addindel.py：用于在 BAM 文件中添加插入缺失。
• addsnv.py：用于在 BAM 文件中添加单核苷酸变异。
• addsv.py：用于在 BAM 文件中添加结构变异。

这些脚本可以通过命令行直接调用，例如：

python3 -O bin/addsv.py -p 1 -v test_data/test_sv.txt -f test_data/testregion_realign.bam -r test_data/Homo_sapiens_chr22_assembly19.fasta -o test_data/testregion_sv_mut.bam --aligner mem --keepsecondary --seed 1234 --inslib

3. 项目的配置文件介绍

BAMSurgeon 项目本身不包含传统的配置文件，其参数主要通过命令行传递。例如，在调用 addsv.py 时，可以通过命令行参数指定输入文件、输出文件、参考基因组等。

以下是一些常用的命令行参数：

• -p：指定进程数。
• -v：指定包含突变信息的文件。
• -f：指定输入的 BAM 文件。
• -r：指定参考基因组文件。
• -o：指定输出的 BAM 文件。
• --aligner：指定对齐工具，如 mem。
• --keepsecondary：保留次要对齐。
• --seed：设置随机种子。
• --inslib：指定插入序列库。

通过这些命令行参数，用户可以灵活地配置和运行 BAMSurgeon 项目。