Skip to content

Latest commit

 

History

History
116 lines (83 loc) · 5.29 KB

README.md

File metadata and controls

116 lines (83 loc) · 5.29 KB
Raw

Platform

Metabuli App

This is the desktop application for Metabuli, a metagenomic classification that jointly analyzes both DNA and amino acid sequences. Built with Vue.js and Electron, it provides an intuitive interface for running metagenomic classification jobs and visualizing the results.

For more details of Metabuli, please see GitHub, Nature Methods, PDF, bioRxiv, or ISMB 2023 talk.

NOTE

The NCBI and Assemblies buttons in the Sankey subtree view do not work when searching against a GTDB-based database. We will make a button for GTDB soon.

Platforms Supported

  • macOS (Universal .dmg)
  • Windows (.exe)
  • Linux (AppImage .AppImage)

Functionality

  • Download pre-built databases
  • Run new taxonomic profiling
  • Upload and browse taxonomic profiling results
  • Extract reads classified under a specific taxon
  • Explore results with customizable interactive Sankey plots
  • Explore results with interactive Krona plots

Getting Started

Installation

  • Visit the GitHub Releases page for the latest builds.
  • The application is pre-built for macOS, Windows, and Linux.
  • Simply download the executable for your platform from the Releases section.

Note: If you encounter a security warning when opening the app, follow the instructions below to bypass the warning:

  • macOS: Refer to this guide on how to open apps from unidentified developers.
  • Windows: Click 'More info' and then 'Run anyway' to continue.

Usage

The Metabuli App provides two modes for metagenomic classification: New Search and Upload Report. These modes are accessible via tabs in the Search Settings panel.

New Search

To run a New Search job, follow these steps: SearchPage_Demo_Image

  1. Required Fields: Complete the following mandatory fields:

    • Mode: Select the analysis mode:
      • Single-end
      • Paired-end
      • Long-read
    • Job ID: Enter a unique identifier for the job.
    • Select Files: Upload the necessary files and directories:
      • Read 1 File (and Read 2 File if Paired-end is selected)
      • Database Directory
      • Output Directory
    • Max RAM: Specify the maximum RAM (in GiB) to allocate for the job.

  2. Advanced Settings (Optional): Configure optional parameters to fine-tune the analysis:

    • Threads
    • Min Score
    • Min SP Score
    • Taxonomy Path
    • Accession Level

  3. Start Analysis:

    • Click the Run Metabuli button to start the metagenomic classification process.
    • You can track the progress and see real-time backend output in the logs.

  4. View Results:

    • Once the analysis is complete, you can view the results in three different forms:
      • Table: View the raw classification data in a table format.
      • Sankey Diagram: A flow diagram representing the lineage information of the displayed taxa.
      • Krona Chart: A hierarchical interactive chart that visualizes classification results.

Upload Report

To visualize results from a previously completed job:

  1. Navigate to the Upload Report tab.
  2. Upload the report.tsv file from a prior job.
  3. View the uploaded results directly in the Results tab. For this job type, results are provided in:
    • Table: The raw data in table format.
    • Sankey Diagram: A flow diagram representing the lineage paths for the displayed taxa (without the Krona chart).

Demos

New Search Job Demo

Watch this demo to see how to run a new search on Metabuli:

NewSearch_Demo_Video.mov

Viewing Results

Watch this demo to see how to view the results from a completed search:

Metabuli.Demo.v1.0.0.View.Results.mp4

Acknowledgments

The development of the Metabuli Desktop Application has been inspired by and leverages the following tools:

  • Pavian: Elements of the table layouts and visualizations in Metabuli were inspired by Pavian for metagenomic data analysis. (Pavian GitHub Repository).

  • Krona: The Krona tool is embedded in the results page for hierarchical data visualization. (Krona Github Repository).

We would like to acknowledge the authors of Pavian and Krona for their excellent work, which has significantly contributed to the development of Metabuli.