Skip to content

zy-optimistic/GAEP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GAEP

A genome assembly evaluating pipeline.

Introduction

GAEP is a pipeline to assess genome assembly.

Installation

git clone https://github.com/zy-optimistic/GAEP.git
cd GAEP  
./gaep  

Docker container

# Assuming docker and Apptainer are installed already
# Use the supplied Dockerfile to build a docker container
docker build -t gaep_pipeline .

# Now use apptainer to build a transferable container from the docker image on this machine
apptainer build gaep.sif docker-daemon:gaep_pipeline:latest

# Test
apptainer run gaep.sif gaep stat <fasta file>

Usage

gaep <command> [options]

pipe   (NGS,TGS,trans)  let GAEP to determine the module to be executed based on the input data   
stat                    report genome basic information  
macc   (NGS)            base accuracy based on reads mapping  
kacc   (NGS)            base accuracy based on K-mer  
bkp    (TGS)            misassembly breakpoints detected  
snvcov (NGS,TGS)        SNV-coverage dot plot  
busco                   run busco v5  

Running example

gaep pipe -r genome.fasta --lr TGS.fastq -x pb --sr1 NGS_1.fastq --sr2 NGS_2.fastq -t 3 -c config.txt
#You can list your data and dependancies in the config.txt. The template of config.txt is in GAEP/config/.

Dependencies

The specified versions were used for testing GAEP.

Misassembliy breakpoint detection (bkp)

  • Bio::DB::HTS (perl module). Can be installed by conda with command "conda install -c bioconda perl-bio-db-hts".
  • minimap2 v2.17-r974-dirty
  • samtools v1.9

SNV-Cov dot plot (snvcov)

  • minimap2 v2.17-r974-dirty (for TGS reads mapping)
  • bwa v0.7.17-r1198-dirty (for NGS reads mapping)
  • bcftools v1.9 (for SNV calling)
  • Rscript v4.0.3 (for plotting)
  • bedtools
  • ggplot2 (R module)
  • ggExtra (R module)

Base accuracy (macc)

  • bwa v0.7.17-r1198-dirty
  • samtools v1.9
  • bcftools v1.9

Base accuracy (kacc)

  • meryl v1.3
  • merqury v1.3

busco v5

  • busco v5
  • metaeuk (for eukaryotes)
  • prodigal (for non-eukaryotes)
  • hmmsearch
  • bbtools

About

A genome assembly assessment pipeline.

Resources

License

Stars

39 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors