GithubHelp home page GithubHelp logo

ivanv87 / markermag Goto Github PK

View Code? Open in Web Editor NEW

This project forked from songweizhi/markermag

0.0 0.0 0.0 8.18 MB

Linking MAGs with 16S rRNA marker genes

License: GNU Affero General Public License v3.0

Shell 2.76% Python 95.15% Perl 2.09%

markermag's Introduction

MarkerMAG: linking MAGs with 16S rRNA marker genes using paired-end short reads

pypi licence pypi version Bioconda DOI

Publication

Updates

  • 2022-05-08 - MarkerMAG is now available on Bioconda, please refers to "How to install" for details.
  • 2022-03-12 - A demo dataset (together with command) has now been provided! You can use it to check if MarkerMAG is installed successfully on your system.

MarkerMAG modules

  1. Main module

    • link: linking MAGs with 16S rRNA marker genes
  2. Supplementary modules

    • rename_reads: rename paired reads (manual)
    • matam_16s: assemble 16S rRNA genes with Matam (manual)
    • barrnap_16s: identify 16S rRNA genes from genomes/MAGs with Barrnap (manual)

How to install

  • MarkerMAG is implemented in python3, It has been tested on Linux and MacOS, but NOT on Windows.

  • A Conda package that automatically installs MarkerMAG's third-party dependencies (except Usearch ⚠️) is now available. Please note that you'll need to install Usearch on your own as it's not available in Conda due to license issue.

    # install with 
    conda create -n MarkerMAG_env -c bioconda MarkerMAG
    
    # To activate the environment    
    conda activate MarkerMAG_env
    # MarkerMAG is ready for running now, type "MarkerMAG -h" for help
    
    # To deactivate the environment
    conda deactivate
    
  • It can also be installed with pip. Software dependencies need to be in your system path in this case. Dependencies for the link module include BLAST+, Barrnap, seqtk, Bowtie2, Samtools, HMMER, metaSPAdes and Usearch. Dependencies for the supplementary modules are provided in their corresponding manual page.

    # install with 
    pip3 install MarkerMAG
      
    # upgrade with 
    pip3 install --upgrade MarkerMAG
    
  • Here are some example commands for UNSW Katana users.

  • ⚠️ If you clone the repository directly off GitHub you might end up with a version that is still under development.

How to run

  • MarkerMAG’s input consists of

    1. A set of user-provided MAGs
    2. A set of 16S rRNA gene sequences (either user-provided or generated with the matam_16s module)
    3. Input reads need to be quality-filtered and in fasta format (no quality score).
  • ⚠️ MarkerMAG is designed to work with paired short-read data (i.e. Illumina). It assumes the id of reads in pair in the format of XXXX.1 and XXXX.2. The only difference is the last character. You can rename your reads with MarkerMAG's rename_reads module (manual).

  • Although you can use your preferred tool to reconstruct 16S rRNA gene sequences from the metagenomic dataset, MarkerMAG does have a supplementary module (matam_16s) to reconstruct 16S rRNA genes. Please refer to the manual here if you want to give it a go.

  • Link 16S rRNA gene sequences with MAGs (demo dataset):

    MarkerMAG link -p Demo -r1 demo_R1.fasta -r2 demo_R2.fasta -marker demo_16S.fasta -mag demo_MAGs -x fa -t 12
    

Output files

  1. Summary of identified linkages at genome level:

    Marker MAG Linkage Round
    matam_16S_7 MAG_6 181 Rd1
    matam_16S_12 MAG_9 102 Rd1
    matam_16S_6 MAG_59 55 Rd2
  2. Summary of identified linkages at contig level (with figure):

    Marker___MAG (linkages) Contig Round_1 Round_2
    matam_16S_7___MAG_6(181) Contig_1799 176 0
    matam_16S_7___MAG_6(181) Contig_1044 5 0
    matam_16S_12___MAG_9(102) Contig_840 102 0
    matam_16S_6___MAG_59(39) Contig_171 0 55

    linkages

  3. Copy number of linked 16S rRNA genes.

  4. Visualization of individual linkage.

    MarkerMAG supports the visualization of identified linkages (needs Tablet). Output files for visualization (example) can be found in the [Prefix]_linkage_visualization_rd1/2 folders. You can visualize how the linking reads are aligned to MAG contig and 16S rRNA gene by double-clicking the corresponding ".tablet" file. Fifty Ns are added between the linked MAG contig and 16S rRNA gene.

    linkages

    *If you saw error message from Tablet that says input files format can not be understood, please refer to here for a potential solution.

markermag's People

Contributors

songweizhi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.