Skip to main content

Ibis (Australian bin chicken) - targeted recovery of low abundance genomes through intelligent coassembly

Project description

Ibis

Ibis (bin chicken) - targeted recovery of low abundance genomes through intelligent coassembly.

Installation options

Install from source

Create conda env from ibis.yml and install from source.

git clone https://github.com/AroneyS/ibis.git
cd ibis
conda env create -f ibis.yml
conda activate ibis
pip install -e .

Create subprocess conda environments

ibis build --conda-prefix /path/to/conda/envs

Alternatively, set directory to contain subprocess conda environments

conda env config vars set SNAKEMAKE_CONDA_PREFIX="/path/to/conda/envs"

Install from pip

Install latest release via pip.

pip install ibis-genome

Ibis coassemble

Snakemake pipeline to discover coassembly sample clusters based on co-occurrence of single-copy marker genes, excluding those genes present in reference genomes (e.g. previously recovered genomes). The taxa of the considered sequences can be filtered to target a specific taxon (e.g. the phylum Planctomycetota). Assembly and recovery can be run directly, or the coassemblies with differential-abudance-binning samples can be run in the tool of your choice. Aviary assemble/recover commands are also generated based on proposed coassemblies. Optionally, reads can be mapped to the matched bins with only unmapped reads being assembled. Paired end reads of form reads_1.1.fq, reads_1_1.fq and reads_1_R1.fq are automatically detected and matched to their basename.

# Example: cluster reads into proposed coassemblies
ibis coassemble --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --no-genomes

# Example: cluster reads into proposed coassemblies based on unbinned sequences
ibis coassemble --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ...

# Example: cluster reads into proposed coassemblies based on unbinned sequences and coassemble only unbinned reads
ibis coassemble --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ... --assemble-unmapped

# Example: cluster reads into proposed coassemblies based on unbinned sequences from a specific taxa
ibis coassemble --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ... --taxa-of-interest "p__Planctomycetota"

# Example: find relevant samples for differential coverage binning (no coassembly)
ibis coassemble --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --single-assembly

Ibis evaluate

Evaluates the recovery of target genes by coassemblies suggested by above, finding the number of target genes present in the newly recovered genomes. Compares the recovery by phyla and by single-copy marker gene.

# Example: evaluate a completed coassembly
ibis evaluate --coassemble-output coassemble_dir --aviary-outputs coassembly_0_dir ...

# Example: evaluate a completed coassembly by providing genomes directly
ibis evaluate --coassemble-output coassemble_dir --new-genomes genome_1.fna ... --coassembly-run coassembly_0

Ibis iterate

Run a further iteration of coassemble, including newly recovered bins.

# Example: rerun coassemble, adding new bins to database
ibis iterate --aviary-outputs coassembly_0_dir ... --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ...

# Example: rerun coassemble, adding new bins to database, providing genomes directly
ibis iterate --new-genomes new_genome_1.fna ... --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ...

# Example: rerun coassemble, adding new bins to database, excluding previous coassembly combinations
ibis iterate --exclude-coassemblies reads_1,reads_2 --new-genomes new_genome_1.fna ... --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ...

Ibis update

Applies further processing to a previous Ibis coassemble run: downloading SRA reads, generating unmapped reads files, and/or running assembly/recovery commands.

# Example: update previous run to download SRA reads
ibis update --sra --coassemble-output coassemble_dir --forward SRA000001 ... --genomes genome_1.fna ...

# Example: update previous run to perform unmapping
ibis update --assemble-unmapped --coassemble-output coassemble_dir --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ...

# Example: update previous run to run specific coassemblies
ibis update --run-aviary --coassemblies coassembly_0 ... --coassemble-output coassemble_dir --forward reads_1.1.fq ... --reverse reads_1.2.fq ... --genomes genome_1.fna ...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ibis-genome-0.9.6.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

ibis_genome-0.9.6-py3-none-any.whl (62.8 kB view details)

Uploaded Python 3

File details

Details for the file ibis-genome-0.9.6.tar.gz.

File metadata

  • Download URL: ibis-genome-0.9.6.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for ibis-genome-0.9.6.tar.gz
Algorithm Hash digest
SHA256 f0e9d17ffa9bd6a641746d4f1cd0a2cf9e7be27d7170ecef48a0b36315e3eac2
MD5 900ef0945f2fd79b03adafbb0f56b3fc
BLAKE2b-256 e772f0775cfbedd99a07ac203d934d09ace03dda2f0671794414157515e60fcc

See more details on using hashes here.

File details

Details for the file ibis_genome-0.9.6-py3-none-any.whl.

File metadata

  • Download URL: ibis_genome-0.9.6-py3-none-any.whl
  • Upload date:
  • Size: 62.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for ibis_genome-0.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7996eb2e70b80cd5df859c54ef97409d19989ce5651cf38fca812212cf3b4e11
MD5 88c143e62408607b9c7181b57d6b79d5
BLAKE2b-256 632eef0a6d96982d37c95833f6c2b53523ee2e07a5f1b621755f27e1a8c1e57e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page