Skip to main content

Meteor - A plateform for quantitative metagenomic profiling of complex ecosystems

Project description

Meteor

install with conda PyPI dockerhub Github Actions codecov DOI

Introduction

Meteor is a plateform for quantitative metagenomics profiling of complex ecosystems. Meteor relies on genes catalogue to perform species-level taxonomic profiling, functional analysis and strain-level population structure inference.

Dependencies

Besides python packages dependencies, Meteor requires:

Installation

Meteor is available with conda which includes all its dependencies:

conda create --name meteor -c conda-forge -c bioconda meteor

Or with pip with a recent Python 3.10+:

pip install meteor

You can test the installation of meteor with:

meteor test

Getting started

A basic usage of meteor will require to:

  1. Download or build a reference catalogue
  2. Structure the raw fastq files
  3. Map reads against the reference catalogue
  4. Compute taxonomical and/or functional abundances
  5. Strain profiling

1. Download or build a custom reference


Meteor requires to download locally a microbial gene catalogue specif, either in 'full' or 'light' version. The 'full' version contains all genes of the catalogue, whereas the 'light' version contains only the marker genes that will be used to infer species abundance profiles. Of note, no functional profiling can be performed when using the 'light' version of a catalogue.

Ten catalogues are currently available:

Microbial gene catalogue <name> Genes count (M) Metagenomic Species Pan-genomes (MSPs) Size (full) (GB) Size (light) (GB) Description
Felis catus cat_gut 1.3 344 2.0 0.2 link
Gallus gallus domesticus chicken_caecal 13.6 2420 19.6 1.2 link
Canis lupus familiaris dog_gut 0.95 234 1.4 0.1 link
Homo sapiens gut human_gut 10.4 1990 12.6 0.7 link
Homo sapiens oral human_oral 8.4 853 13.7 0.5 link
Homo sapiens skin human_skin 2.9 392 3.9 0.2 link
Mus musculus mouse_gut 5.0 1252 10.3 0.6 link
Oryctolagus cuniculus rabbit_gut 5.7 1053 8.0 0.4 link
Rattus norvegicus rat_gut 5.9 1627 7.0 0.6 link
Sus domesticus pig_gut 9.3 1523 11.3 0.7 link

These references can be downloaded with the following command:

meteor download -i <name> -c -o <refdir>

The 'light' catalogues are available with the tag (--fast) :

meteor download -i <name> -c --fast -o <refdir>

Users can also import custom gene catalogue with the command:

meteor build -i <fastafile> -n <name> -o <refdir> -t <threads>

2. Import fastq


Meteor requires a first of fastq indexing:

meteor fastq -i <fastqdir>  [-p paired reads] -n <projectname> -o <outputdir>

When multiple sequencing are available for a library, the option -m allows to group these samples. Example:

Illumina_lib1-SAMPLE_01.fastq
Illumina_lib1-SAMPLE_02.fastq
Illumina_lib2-SAMPLE_01.fastq
Illumina_lib2-SAMPLE_02.fastq

In this case, the following command will group these samples the same library:

meteor fastq -i ./  -m SAMPLE_\\d+ -n projectname -o outputdir

3. Mapping


The fastq files are mapped against a catalogue to generate a gene count table with the following command:

meteor mapping -i <fastqdir/sampledir> -r <refdir> -o <mappingdir>

We recommend to first filter out reads with low-quality, length < 60nt or belonging to the host.

4. Taxonomic and functional profiling


Genes from the catalogue are clustered into Metagenomic Species Pangeomes (MSP) with MSPminer, and are functionnaly annotated against KEGG r107, DBcan (carbohydate active enzymes) and MUSTARD (antibiotic resistant determinants).

MSP and functional profiles are computed from the gene count table with the following command:

meteor profile -i <mappingdir/sampledir> -o <profiledir> -r <refdir> -n coverage

The "-n" parameter ensures read count normalization for gene length. If omitted, no normalization will be performed on the gene table.

This profiling step will generate:

  • a Species abundance table;
  • an ARD abundance table (full catalogue only);
  • a DBCAN abundance table (full catalogue only);
  • a Gut Metabolic Modules (GMM) abundance table (from the KO annotation) (full catalogue only).
  • a Gut Brain Modules (GBM) abundance table (from the KO, EGGNOG and TIGRFAM annotations) (full catalogue only).

5. Merging

To merge output from different samples into a single table, use the following command:

meteor merge -i <profiledir> -o <mergingdir>

5. Strain profiling


Meteor is capable of profiling strains in large metagenomic datasets. It identifies specific mutations from strains and applies them to the gene catalog MSPs.

To use Meteor for strain profiling, use the following command:

meteor strain -i <mappingdir/sampledir> -o <straindir> -r <refdir>

Meteor computes mutation rates and trees between strains from samples using a GTR+GAMMA model with the following command:

meteor tree -i <straindir> -o <treedir>

The METEOR team

The main contributors to METEOR:

  • Franck Gauthier
  • Amine Ghozlane
  • Florian Plaza Oñate
  • Nicolas Pons
  • Florence Thirion

Acknowledgements

Special thanks to the following people:

  • Mathieu Almeida
  • Emmanuelle Le Chatelier

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

meteor-2.0.17.tar.gz (61.4 MB view details)

Uploaded Source

Built Distribution

meteor-2.0.17-py3-none-any.whl (61.5 MB view details)

Uploaded Python 3

File details

Details for the file meteor-2.0.17.tar.gz.

File metadata

  • Download URL: meteor-2.0.17.tar.gz
  • Upload date:
  • Size: 61.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for meteor-2.0.17.tar.gz
Algorithm Hash digest
SHA256 b10a7178e4675ac37edd24e7699ac4e70b8ec9c155d33213ab3d2981849c9a36
MD5 34892f07a290a336179168a3a3ed52fb
BLAKE2b-256 de1feee2459eb8b151af312ea4a093833064b6f90c8891000381fc9cb20a55f2

See more details on using hashes here.

File details

Details for the file meteor-2.0.17-py3-none-any.whl.

File metadata

  • Download URL: meteor-2.0.17-py3-none-any.whl
  • Upload date:
  • Size: 61.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for meteor-2.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 f8098308d2c567f40e2bd8dc217be540f1fe3bd27b6de5cdca7d2575ad7fe004
MD5 5eb0e70bd951b4cbc2911528fd1e2ada
BLAKE2b-256 b8ab15cf204fae4e9721be8319756959486ab981518f13993c7f2a1930af6ab9

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