Skip to content

About

No description, website, or topics provided.

Resources

Stars

6 stars

Watchers

1 watching

Forks

Latest commit

 

History

60 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

DOI

Comparative analysis of methodologies for detecting eccDNA

Implementation description We collected 7 eccDNA datasets and designed a pipeline to simulate eccDNA data generated by eccDNA-enriched experimental methods.

Getting Stared

Latest updates

version 1.0.1 May 2024

  • Fix a bug in class seqsim that can not simulate data with only simple or chimeric eccDNA template.
  • Package the pipeline using setuptools

version 1.0.0 Nov 2023

  • Upload ecsim for simulated eccDNA datasets

Requirements

Note1: The current version of ecsim only supports Linux and MacOS.

Note2: To run ecsim, please ensure that pysam, art, seqkit, pandas, numpy, and pbsim2 have already been installed.

It would take several minutes to create the environment.

git clone https://github.com/QuKunLab/eccDNABenchmarking.git
cd eccDNABenchmarking/ecsim
conda env create -f environment.yaml

or

conda create -n ecsim -c bioconda pysam=0.21.0 pbsim2=2.0.1 art=3.19.15 seqkit=2.6.1 python=3.9 pandas=2.0.2 numpy=1.25.0

Installation

It would take several seconds to install ecsim.

conda activate ecsim
cd eccDNABenchmarking/ecsim
pip install .

Tutorial

Note: Parameters sample,reference,thread,path are required.

It would take hours to generate simulated dataset with 10000 circular and 10000 linear DNA, with a 5000bp extention of RCA and a sequencing depth of 50.

ecsim --sample SAMPLE_NAME (required) \
      --reference REFERENCE_PATH (required) \
      --thread THREAD_NUMBER (required) \
      --path DATA_PATH (required) \
      --simple-template SIMPLE_TEMPLATE_BEDFILE (Alternative) \
      --chimeric-template CHIMERIC_TEMPLATE_BEDFILE (Alternative) \
      --simple-ratio SIMPLE_DNA_RATIO (default is calculated from profile) \
      --meancov SEQUENCING_DEPTH (default=25) \
      --circular-number CIRCULAR_DNA_NUMBER (default=10000) \
      --linear-number LINEAR_DNA_NUMBER (default=10000) \
      --amp AMPLIFIED_LENGTH (default=5000) \
      --seed RANDOM_SEED (default=None) \
      --ont-model PBSIM2_MODEL_NAME (default='R94') \
      --ont-mean ONT_READ_LENGTH_MEAN (default=3000) \
      --ont-std ONT_READ_LENGTH_STD (default=2500) \
      --sr-platform ILLUMINA_PLATFORM (default='HS25') \
      --sr-mean ILLUMINA_INSERT_LENGTH_MEAN (default=400) \
      --sr-std ILLUMINA_INSERT_LENGTH_STD (default=125) \
      --sr-readlen ILLUMINA_READ_LENGTH (default=150)

The template bed files (data used in this project) are stored in resource directory. If you not specify template files, default simple_template is template.simple.bed and default chimeric_template is template.chimeric.bed.

Expected Output: ecsim will generate files contaning simulated eccDNA information in bed and FASTA format, and Simulated Illumina and Oxford Nanopore sequencing data in FASTQ fomat.

About

No description, website, or topics provided.

Resources

Stars

6 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages