Skip to main content

License: MIT

GitHub last commit (branch)

MitoBee logo

MitoBee

Snakemake workflow to get mitogenomes from metagenomic data

Still under development! Stable release out as a version, but only if there is a closely related mitogenome available.

Documentation: Wiki

Install

Source install Run the below commands:

git clone https://github.com/npbhavya/MitoBee.git
cd MitBee
mamba create -y -n mitobee python=3.13
conda activate mitobee
pip install -e . 

Once I have a stable version release, I will upload them to conda and pip as well

Running the code

Note: This code works only on paired end metagenomes for now.

This workflow is made modular;

  1. mitobee run If there is a representative closely related genome mitogenome, provide that as the host seq and get started
    #Running mitobee with test files available in the repo
    mitobee run --input test-files/metagenomes --extn fastq.gz \
         --pattern_r1 _R1 --pattern_r2 _R2 \
         --host_seq test-files/am-dh4.fasta \
         --output output
  1. mitobee tree Once the mitochondrial genomes are built from each metagenome sample, run this module to build a tree with these mitogenomes and other references
    #After the mitogenomes are made from the mitobee run results. Add other references to build a tree
    #Once again example with test files
    mitobee tree --input test-files/mitogenomes --extn fasta --output output -k all

  1. mitobee search If there is a no closely related mitogenome available, then this step can be run first to search against a set of mitogenomes or mito genes This module will provide an overview of which reference to use
    #If a closely related mitochondrial genome is not available, but a gene is, like cox  or rRNA genes
    #Download the reference genes you would like to use of the closely related genomes

    #to search against mitogenomes refernece set
    mitobee search --input test-files/mitogenomes --extn fastq.gz \
        --pattern_r1 _R1 --pattern_r2 _R2 \
        --ref_seq  test-files/ref-set-genome --output output \
        -k all --mode mitogenome

    #to search against mitogenomes refernece gene set 
    mitobee search --input test-files/mitogenomes --extn fastq.gz \
        --pattern_r1 _R1 --pattern_r2 _R2 \
        --ref_seq  test-files/ref-set-genes --output output \
        -k all --mode genes 

Input files

Input files:

  • Input directory with metagenomes
  • Reference directory
    • If running run or tree module, provide a (one) reference genome.
    • If running gene module, provide a reference gene set

Output files

Output files: Provide the output folder, contains subdirectories

  • PROCESSING: Folder containing intermediate files
  • REPORTS: Final results including the mitogenome fasta files from (hopefully) each metagenome sample
    Also inlcudes the QC reports, to include stats on how many reads were processed, and not

Metadata

Release files for MitoBee 1.0.post0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for MitoBee 1.0.post0
File Size Uploaded
mitobee-1.0.post0.tar.gz 6.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for MitoBee 1.0.post0
File Interpreter ABI Platform
mitobee-1.0.post0-py3-none-any.whl Python 3 none any Details

Total release size: 13.8 kB

Release files / mitobee-1.0.post0.tar.gz

Download URL mitobee-1.0.post0.tar.gz
Size 6.7 kB
Tags Source
SHA-256 checksum
How to use checksums
4406c2df0ca6a32fcc96ba5b5531b1e513899e4ff2916700d928ecdfbc019e9c
BLAKE2b-256 checksum
How to use checksums
f4c23c91100dc3a90a676d7a063e8d240f174eaf60e9e76061c129dee2eee281
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / mitobee-1.0.post0-py3-none-any.whl

Download URL mitobee-1.0.post0-py3-none-any.whl
Size 7.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ca66da416fa290f70cded959e6a4a64a6259bcaa2e31aafc78da132dfe47e5d
BLAKE2b-256 checksum
How to use checksums
1c64566c1ddfc3121b675496ef9050fecf18ff2d9ce78616861c7fc5c2d66e3e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

1.0.post0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page