Welcome to metaFun#
#
metaFun : An analysis pipeline for metagenomic big data with fast and unified Functional searches#
metaFun is implemented in Nextflow with apptainer. You can easily run this pipeline with easy installation using conda or mamba. This package is deposited in Bioconda channel (https://anaconda.org/bioconda/metafun)
Introduction#
metaFun is aimed at agile and scalable generation of metagenome assembled genomes and taxonomic profiling with statistical analysis. Using user interested genomes with metadata, this pipeline enables fast comprative genomic analysis and functional annotation.
Birdeye view of metaFun pipeline. This pipeline is comprised of six analytical modules and two interactive modules.#
Quick Start#
Install Prerequisites (conda, miniconda, or mamba)
# Install miniconda or mamba wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh bash Miniconda3-latest-Linux-x86_64.sh
Install metaFun
# make metafun environment git clone https://github.com/aababc1/metaFun.git cd metaFun # Create environment conda create -n metafun bioconda::metafun conda activate metafun
Download Databases
(metafun) metafun -module DOWNLOAD_DB # get help (metafun) metafun -help
Getting Started
- 1. Quick start
- 1.1. metaFun install and run
- 1.2. RAWREAD_QC: Quality control of raw reads and host genome filtering
- 1.3. ASSEMBLY_BINNING: Assembly and binning
- 1.4. BIN_ASSESSMENT: Assess genome quality and taxonomy classification
- 1.5. GENOME_SELECTOR: Genome selection interface
- 1.6. COMPARATIVE_ANNOTATION: Comparative genomic analysis
- 1.7. INTERACTIVE_COMPARATIVE: Interactive comparative analysis
- 1.8. WMS_TAXONOMY: Taxonomic profiling of metagenomic reads
- 1.9. INTERACTIVE_TAXONOMY: Interactive taxonomy analysis
- 1.10. WMS_FUNCTION: Functional analysis of metagenomic reads
- 1.11. DOWNLOAD_DB: Download required databases
- 1.12. PREPARE_CUSTOM_HOST: Prepare custom host genome index
- 1.13. Common Options
- 2. Beginners Guide to metaFun
metaFun workflows
- Workflows description
- this is RAWREAD_QC description page.
- RAWREAD_QC
- ASSEMBLY_BINNING
- BIN_ASSESSMENT
- Overview
- Module Execution
- Module Operation Sequence
- Parameters
- Inputs and Outputs
- Execution Examples and Results
- Nextflow Processes in BIN_ASSESSMENT Module
- Descriptions of Processes in BIN_ASSESSMENT Workflow
- Tools Used in BIN_ASSESSMENT
- Custom Scripts in BIN_ASSESSMENT
- Usage Notes
- Next Steps
- Combining Metadata with Quality/Taxonomy Results
- COMPARATIVE_ANNOTATION
- COMPARATIVE_ANNOTATION Workflow
- WMS_TAXONOMY
- WMS_FUNCTION