/Triti-Map

A Snakemake-based pipeline for gene mapping in Triticeae.

Primary LanguagePythonMIT LicenseMIT

Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

Triti-Map is a Snakemake-based pipeline for gene mapping in Triticeae, which contains a suite of user-friendly computational packages and web-interface integrating multi-omics data from Triticeae species including genomic, epigenomic, evolutionary and homologous information.

Triti-Map could efficiently explore trait-related genes or functional elements not present in the reference genome and reduce the time and labor required for gene mapping in large genome species.

More thorough information and explanations are provided in the Triti-Map Wiki.

Triti-Map workflow overview

Triti-Map ptimization steps to address specific challenges of Triticeae gene-mapping

Getting Started with Triti-Map

Installation

Installing from Bioconda

First, to install Triti-Map you need a UNIX environment contains Bioconda. See how to install Conda

# create new environment and install Triti-Map
conda create -c conda-forge -c bioconda -n tritimap tritimap
# activate Triti-Map environment
conda activate tritimap
# test Triti-Map
tritimap --help

Installing from GitHub

# download Triti-Map
git clone https://github.com/fei0810/Triti-Map.git
cd Triti-Map
# install Triti-Map
python setup.py install

When using source code for installation, you need to install other dependencies of Triti-Map by yourself. You can view Triti-Map dependent software via tritimap_env.yaml

Preparing relevant files

Genome and annotation files

Downloading the genome and annotation files you need. Here are some links to download the genome of the Triticeae species.

Building GATK and samtools index file

# for example
# GATK index
gatk CreateSequenceDictionary -R /genome/path/genome.fasta
# samtools index
samtools faidx /genome/path/genome.fasta

DNA-seq data use bwa-mem2

# for example
bwa-mem2 index /genome/path/genome.fasta

RNA-seq data use STAR

# for example
STAR --runThreadN 30 --runMode genomeGenerate \
--genomeDir /star/index/path/genome_star \
--genomeFastaFiles /genome/path/genome.fasta \
--sjdbOverhang 100 \
--sjdbGTFfile /anntotaion/path/genome.gtf \
--genomeChrBinNbits 18 \
--limitGenomeGenerateRAM 50805727274

Configuration files

# generate configuration file in current directory
tritimap init

#Or generate configuration file in running directory
tritimap init -d /your/work/path

When tritimap init is run successfully, the working directory will generate three configuration files that you need to modify.

  • config.yaml: Triti-Map configuration file
  • sample.csv: Sample information file
  • region.csv: Chromosome region file used to filter the raw results (required only when running Assembly Module alone)

The Triti-Map wiki contains detailed information about the meaning and usage of each parameter in the configuration file.

Running Triti-Map

conda activate tritimap
# running directory
cd /your/work/path

# three types of analysis method

# running both Interval Mapping Module and Assembly Module
tritimap run -j 30 all
# only running Interval Mapping Module
tritimap run -j 30 only_mapping
# only running Assembly Module
tritimap run -j 30 only_assembly

Triti-Map supports three types of analysis method.

  • tritimap run -j 30 only_mapping: If you only need to identify trait association intervals and mutations, then run the Interval Mapping Module.
  • tritimap run -j 30 only_assembly: If you only need to identify trait association new genes, then run the Assembly Module.
  • tritimap run -j 30 all: run the Interval Mapping Module and the Assembly Module together.

Note: Triti-Map pipeline may take a long time to run(1 to 2 days). The screen command is useful for the cases when you need to start a long-running process. Learn more about GNU Screen.

Exploring Triti-Map's results

A complete catalog of Triti-Map results is shown below.

├── results
│   ├── 01_cleandata
│   ├── 02_mergedata
│   ├── 03_mappingout
│   ├── 04_GATKout
│   ├── 05_vcfout
│   ├── 06_regionout
│   ├── 07_assembleout
│   ├── logs

You can learn about the results generated by Triti-Map in the Triti-Map wiki.

More

Frequently Asked Questions

You can also check out some of the FAQ you may encounter during use Triti-Map

Change Log

Citing

Author/Support

Fei Zhao zhaofei920810@gmail.com

Lab Home Page:http://bioinfo.sibs.ac.cn/zhanglab/

Issues can be raised at: https://github.com/fei0810/Triti-Map/issues

We also encourage you to contribute to TriTi-Map! To fix bugs or add new features you need to create a Pull Request .