Swarm项目技术文档

1. 安装指南

用户可以从发布页面获取适用于GNU/Linux、macOS或Windows的最新二进制文件。也可以通过GitHub使用ZIP按钮或git clone获取源代码，并使用GCC（版本4.8.5或更高）或clang（版本9或更高）编译swarm：

git clone https://github.com/torognes/swarm.git
cd swarm/
make

# 或者，使用 clang
make CC="clang-9" CXX="clang++-9"

如果具有管理员权限，可以将swarm二进制文件复制到/usr/local/bin/或/usr/bin/目录，使其对所有用户可用。也可以按照以下方式安装手册页面：

cd ./man/
gzip -c swarm.1 > swarm.1.gz
mv swarm.1.gz /usr/local/share/man/man1/
# 或者
mv swarm.1.gz /usr/share/man/man1/

安装后，可以使用man swarm命令查看手册页面。

2. 项目的使用说明

Swarm是一个针对扩增子研究的高效、稳健的聚类方法。使用方法非常简单，例如：

./swarm amplicons.fasta

此命令将默认参数（-d 1）应用于amplicons.fasta文件。fasta文件必须是以下格式：

>seqID1_1000
acgtacgtacgtacgt
>seqID2_25
cgtcgtcgtcgtcgt

其中序列标识符是唯一的，并且以表示序列出现次数的值结尾（例如_1000）。有关其他格式的详细信息，请参阅用户手册。

Swarm需要每个fasta条目显示出现次数才能正常工作。此信息可以在去重步骤中生成。

使用swarm -h命令获取简短的帮助信息，或查看用户手册以获取有关输入/输出格式和命令行选项的完整描述。

3. 项目API使用文档

Swarm主要通过命令行接口与用户交互，没有提供传统的API。用户可以通过命令行参数调整Swarm的行为。以下是一些常用的命令行参数：

• --fastidious：启用严格模式，以改进d=1的结果并减少小集群的数量。
• --threads：指定用于并行计算的CPU核心数。
• --seeds：指定一个fasta文件，其中包含作为聚类种子序列的代表。

有关所有参数的详细信息，请查看用户手册。

4. 项目安装方式

除了从源代码编译和通过conda安装之外，以下是使用Swarm的其他安装方法：

通过conda安装

假设已经设置了conda环境（Anaconda或Miniconda），首先激活具有Python 3的环境：

conda activate py3

确保添加了必要的channels以获取bioconda包：

conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge

列出可用的不同版本的Swarm，并安装其中一个：

conda search -c bioconda swarm
conda install -c bioconda swarm=3.0.0=hc9558a2_0
swarm --version  # 检查

确保遵循上述步骤，以便正确安装并使用Swarm项目。