🚀 A sequencing simulator
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
doc
iss
.codecov.yml
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
LICENSE
MANIFEST.in
Pipfile
Pipfile.lock
README.md
setup.py

README.md

InSilicoSeq

A sequencing simulator

Build Status Documentation Status PyPI version codecov doi LICENSE

InSilicoSeq is a sequencing simulator producing realistic Illumina reads. Primarily intended for simulating metagenomic samples, it can also be used to produce sequencing data from a single genome.

InSilicoSeq is written in python, and use kernel density estimators to model the read quality of real sequencing data.

InSilicoSeq support substitution, insertion and deletion errors. If you don't have the use for insertion and deletion error a basic error model is provided.

Installation

To install InSilicoSeq, type the following in your terminal:

pip3 install InSilicoSeq

or if you want to use python2, or are using python3 and pip3 aliased to python and pip:

pip install InSilicoSeq

Alternatively, with docker:

docker pull hadrieng/insilicoseq:1.2.1

For more installation options, please refer to the full documentation

Usage

InSilicoSeq has two subcommands: iss generate to generate Illumina reads and iss model to create an error model from which the reads will take their characteristics.

InSilicoSeq comes with pre-computed error models that should be sufficient for most use cases.

Generate reads with a pre-computed error model

for generating 1 million reads modelling a MiSeq instrument:

curl -O -J -L https://osf.io/thser/download  # download the example data
iss generate --genomes SRS121011.fasta --model miseq --output miseq_reads

where genomes.fasta should be replaced by a (multi-)fasta file containing the reference genome from which the simulated reads will be generated.

InSilicoSeq comes with 3 error models: MiSeq, HiSeq and NovaSeq.

If you have built your own model, pass the .npz file to the --model argument to simulate reads from your own error model.

For 10 million reads and a custom error model:

curl -O -J -L https://osf.io/thser/download  # download the example data
iss generate -g SRS121011.fasta -n 10m --model my_model.npz --output my_reads

granted you have built my_model.npz with iss model (see below)

For more examples and a full list of options, please refer to the full documentation

Generate reads without input genomes

We can download some for you! InSilicoSeq can download random genomes from the ncbi using the infamous eutils

The command

iss generate --ncbi bacteria -u 10 --model MiSeq --output ncbi_reads

will generate 1 million reads from 10 random bacterial genomes.

For more examples and a full list of options, please refer to the full documentation

Create your own error model

If you do not wish to use the pre-computed error models provided with InSilicoSeq, it is possible to create your own.

Say you have a reference metagenome called genomes.fasta, and read pairs reads_R1.fastq.gz and reads_R2.fastq.gz

Align you reads against the reference:

bowtie2-build genomes.fasta genomes
bowtie2 -x genomes -1 reads_R1.fastq.gz -2 reads_R2.fastq.gz | \
samtools view -bS | samtools sort -o genomes.bam
samtools index genomes.bam

then build the model:

iss model -b genomes.bam -o genomes

which will create a genome.npz file containing your newly built model

License

Code is under the MIT license.

Issues

Found a bug or have a question? Please open an issue

Contributing

We welcome contributions from the community! See our Contributing guidelines

Citation

If you use our software, please cite us!

Gourlé H, Karlsson-Lindsjö O, Hayer J and Bongcam+Rudloff E, Simulating Illumina data with InSilicoSeq. Bioinformatics (2018) doi:10.1093/bioinformatics/bty630