Skip to content

YongxinLiu/EasyAmplicon

Repository files navigation

EasyAmplicon (易扩增子)

The Chinese version in (中文版见) README_cn.md

EasyAmplicon: An easy-to-use, open-source, reproducible, and community-based pipeline for amplicon data analysis in microbiome research

Version:v1.22

Update:2025/07/24

Pipeline manual and file description (流程使用和文件介绍)

Using RStudio open the pipeline.sh

Files description:

  • Readme.md # Introduction and install
  • pipeline.sh # Command-line analysis for Windows and Linux
  • pipeline_mac.sh # Command-line analysis for MacOS
  • result/ # Example result data
  • result/Diversity.Rmd # Interactive diversity analysis in R and output reproducible report in HTML format

What can we do? (结果展示)

  • Analysis and visualization of microbiome data, especially for 16S rDNA amplicon;
  • From raw data into feature tables;
  • Support 20+ analysis methods and publish-ready visualization;
  • Finish your project at your laptop in 3 hours;
  • Chinese/English manual and video supported.

image

Figure 1. Pipeline of EasyAmplicon for analyzing paired-end amplicon sequences.

image

Figure 2. Examples of publication-quality visualizations.

image

Figure 3. Supplementary examples of publication-quality visualizations to Figure 2.

image

Figure 4. Visualizations generated by third-party software using the intermediate files of EasyAmplicon.

Install (安装)

Install Dependency (安装依赖软件)

All the software backup can be found in

Please install the dependency software according with you system (Win/Mac/Linux).

The statistics and visualization may require > 500 R packages. Installation is time-consuming and may also rely on other compilation tools. You can download all needed R packages in https://pan.baidu.com/s/1Ikd_47HHODOqC3Rcx6eJ6Q?pwd=0315 db/win/4.x.zip or db/mac/R4.2_mac_libraryX86_64.zip, then unzip and take the 4.x folder in C:\Users[$UserName]\AppData\Local\R\win-library\

# Note: If an R package is missing, you can install it separately using the following methods
# For example, the DADA2 package is hosted on Bioconductor and needs to be installed via BiocManager.
# Please open your R or Rstudio, and enter and execute the following commands in the Console:
# First, install BiocManager's core management tool, BiocManager
if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
# Then, install DADA2 via BiocManager
BiocManager::install("dada2")
# In addition, some R packages can be installed in the conventional way. For example, if you need the argparse package to parse command line arguments, you can use:
install.packages("argparse")
When installing various R packages, a large amount of compilation and installation information may appear in the console. Please wait patiently for it to complete. If you encounter problems, please check your R language environment or network connection according to the prompt.

Install EasyAmplicon 2(安装易扩增子2)

Download the the project in C: or D:, then unzip (keep the directoray name exact the software name)

  • Method 2. Download by the mirror site in BaiduNetDisk: https://pan.baidu.com/s/1Ikd_47HHODOqC3Rcx6eJ6Q?pwd=0315 db/soft/EasyAmplicon.tar.gz or EasyMicrobiome.tar.gz

  • Method 3. git clone https://github.com/YongxinLiu/EasyAmplicon and git clone https://github.com/YongxinLiu/EasyMicrobiome. Note: fatal: unable to access can retry.

Install Conda (安装Conda)

# Download the latest version of miniconda3 v24.9.2, installation date 2024/11/12, 141.47 Mb
wget -c https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh

# Install, -b for batch, -f for no prompt, -p for directory, type yes for license agreement
bash Miniconda3-latest-Linux-x86_64.sh -b -f 

# Activate, then close and reopen the terminal, success if (base) appears before the prompt
~/miniconda3/condabin/conda init
source ~/.bashrc

# Check version, conda 25.5.1, python 3.13.5
conda -V  # 25.5.1
python --version  # 3.13.5

# Add frequently used channels
conda config --add channels bioconda # 生物软件 / Bioconda for bioinformatics software
conda config --add channels conda-forge # Highest priority / Conda-forge has the highest priority

# The default conda configuration file is ~/.condarc. Check the configuration file location

# You are using a new version of Conda (≥24), which requires users to manually accept the Terms of Service (ToS) for each source, otherwise the corresponding channel cannot be used.
# conda tos accept --override-channels --channel https://repo.anaconda.com/pkgs/main
# conda tos accept --override-channels --channel https://repo.anaconda.com/pkgs/r

# mamba is a CLI tool for managing environments. Compared to conda, mamba rewrites some of conda's functions in C++, significantly improving operational efficiency. It can perform parallel downloads and uses libsolv from the rpm package management tool to resolve environment dependencies faster.
conda install mamba -y
mamba install pandas -y
mamba install conda-pack -y

#conda config --set channel_priority strict #设置严格的仓库优先级(最好不要使用)/ Set strict channel priority (better not to use)
#conda config --set channel_priority flexible #禁用仓库优先级 / Disable channel priority

conda config --show-sources

# List conda environments
conda env list

For more Chinese tutorials on conda installation and use, please refer to: Nature Method: Bioconda solves the trouble of biological software installation

Mastering Conda Software Installation in One Article: Virtual Environments, Software Channels, Accelerating Solving, and Cross-Server Migration

Create, install and activate the easyamplicon2 environment

**Note: Choose one of the two options: direct installation or download and unzip for installation. If one method fails, try the other.**
cd EasyAmplicon2

## Method 1. Direct installation
conda env create -f EasyAmplicon2.yaml
conda activate easyamplicon2

## Method 2. Download and install (recommended)
### Specify conda file name
s=easyamplicon2
soft=~/miniconda3

### Download and install
百度网盘下载链接:Baidu Net Disk:https://pan.baidu.com/s/1Ikd_47HHODOqC3Rcx6eJ6Q?pwd=0315
文件路径:db/amplicon/easyamplicon2.tar.gz
File path: db/amplicon/easyamplicon2.tar.gz

### Specify installation directory
mkdir -p ${soft}/envs/${s}
tar -xvzf ${s}.tar.gz -C ${soft}/envs/${s}

### Activate the environment
conda activate ${s}

### Initialize the environment

### The easyamplicon2 environment contains most of the analysis software
conda unpack

Quick Start (快速运行)

Using Windows 10+ as example:

  1. Open RStudio, set termianl as Git Bash (Tools -- Global Options -- Terminal -- New termianls -- Git Bash -- OK)
  2. File -- Open File -- EasyAmplicon folder -- pipeline.sh (windows/linux) or pipeline_mac.sh (mac)
  3. Setup the work directory(wd), and EasyMicrobiome directory(db), then run each line by click run in top right corner

Example dataset (示例数据)

  • seq/ # raw sequencing in zipped fastq format, backup can download by metadata from GSA https://ngdc.cncb.ac.cn/gsa/
  • result/ # Example data and figures for standard pipeline, such as alpha, beta, tax
  • advanced/ # Example of advanced analysis, included data, scripts and output figures

FAQ (常见问题)

Frequenty Asked Questions in pipeline.sh

Note: All the .sh script is writting in markdown format, using Youdao Note or VSCode for better reading experience.

Citation (引文)

使用此脚本,请引用下文:

If used this script, please cited:

Yong-Xin Liu, Lei Chen, Tengfei Ma, Xiaofang Li, Maosheng Zheng, Xin Zhou, Liang Chen, Xubo Qian, Jiao Xi, Hongye Lu, Huiluo Cao, Xiaoya Ma, Bian Bian, Pengfan Zhang, Jiqiu Wu, Ren-You Gan, Baolei Jia, Linyang Sun, Zhicheng Ju, Yunyun Gao, Tao Wen, Tong Chen. 2023. EasyAmplicon: An easy-to-use, open-source, reproducible, and community-based pipeline for amplicon data analysis in microbiome research. iMeta 2: e83. https://doi.org/10.1002/imt2.83

Copyright 2016-2025 Yong-Xin Liu [email protected], Tao Wen [email protected], Tong Chen [email protected]

About

Easy Amplicon data analysis pipeline

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages