SNP-sites 技术文档

1. 安装指南

1.1 Linux - Ubuntu/Debian

如果你使用的是最新版的 Ubuntu 或 Debian，可以通过 apt 命令进行安装：

apt-get install snp-sites

1.2 OSX/Linux - 使用 Bioconda

首先安装 Conda，然后添加 bioconda 频道并安装 SNP-sites：

conda config --add channels conda-forge
conda config --add channels defaults
conda config --add channels r
conda config --add channels bioconda
conda install snp-sites

1.3 OSX/Linux - 从源代码编译

这个方法难度较高，仅适合有高级 Unix 技能的用户。建议使用 Conda。首先安装标准的开发环境（例如 gcc、automake、autoconf、libtool）。从 GitHub 下载软件源码，然后执行以下命令：

autoreconf -i -f
./configure
make
sudo make install

1.4 OSX/Linux - 从发布压缩包安装

这个方法难度较高，仅适合有高级 Unix 技能的用户。建议使用 Conda。首先安装标准的开发环境（例如 gcc、automake、autoconf、libtool）。

tar xzvf snp-sites-x.y.z.tar.gz
cd snp-sites-x.y.z
./configure
make
sudo make install

1.5 所有平台 - Docker

Bioconda 提供了一个 Docker 容器，因此你可以直接使用。安装 Docker，然后从 Bioconda 拉取容器。

1.6 运行测试

测试可以从顶层目录运行：

autoreconf -i
./configure
make
make check

这需要安装 libcheck（在 Ubuntu 中是 check 包）。

2. 项目使用说明

2.1 使用方法

Usage: snp-sites [-mvph] [-o output_filename] <file>

该程序从一个多 fasta 对齐文件中查找 snp 位点。

• -r 输出内部伪参考序列
• -m 输出一个多 fasta 对齐文件（默认）
• -v 输出一个 VCF 文件
• -p 输出一个 phylip 文件
• -o STR 指定输出文件名 [STDOUT]
• -c 仅输出包含 ACGT 的列
• -b 输出单态性位点，用于 BEAST
• -h 显示帮助信息
• -V 打印版本信息并退出

<file> 是输入对齐文件，可以是可选的 gzipped 文件。

2.2 示例输入

给定输入文件：

>sample1
AGACACAGTCAC
>sample1
AGACAC----AC
>sample1
AAACGCATTCAN

输出为：

>sample1
GAG
>sample1
GA-
>sample1
AGT

2.3 示例使用

snp-sites my_alignment.aln
snp-sites my_gzipped_alignment.aln.gz

2.4 输出

• 多 fasta 对齐文件 - 类似于输入文件，但只包含 snp 位点。
• VCF - 包含每个 snp 在参考序列中的位置以及在其他样本中的出现情况。
• 松散的 phylip 格式 - 所有 snp 位点，用于 RAxML 和其他构建树的程序。

3. 项目 API 使用文档

本项目没有提供详细的 API 文档，因为它是命令行工具，主要的使用方式是通过命令行参数进行。

4. 项目安装方式

请参考上文中的“安装指南”部分，选择适合你操作系统的安装方式。