# Meteor
[](https://anaconda.org/aghozlane/meteor)
[](https://pypi.org/project/meteor/)
[](https://hub.docker.com/r/aghozlane/meteor/)
[](https://codecov.io/gh/metagenopolis/meteor)
[](https://zenodo.org/doi/10.5281/zenodo.10912587)
## 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:
- python 3.10+
- [bowtie2 2.3.5+](https://github.com/BenLangmead/bowtie2)
- [bcftools 0.1.19+](https://samtools.github.io/bcftools/)
- [bedtools 2.18.0+](https://bedtools.readthedocs.io/en/latest/index.html)
- [FastTree 1.9.0+](http://www.microbesonline.org/fasttree/)
## Installation
Meteor is available with conda which includes all its dependencies:
```
conda create --name meteor -c conda-forge -c bioconda -c aghozlane 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.7 | 0.9 |[link](https://zenodo.org/records/10719585)
| *Gallus gallus domesticus* | chicken_caecal | 13.6 | 2420 | 22.8 | 4.8 |[link](https://zenodo.org/records/10719564)
| *Canis lupus familiaris* | dog_gut | 0.95 | 234 | 1.7 | 0.3 |[link](https://zenodo.org/records/10719585)
| *Homo sapiens gut* | human_gut | 10.4 | 1990 | 15.1 | 3.2 |[link](https://zenodo.org/records/10719553)
| *Homo sapiens oral* | human_oral | 8.4 | 853 | 16.4 | 3.2 |[link](https://zenodo.org/records/10719586)
| *Homo sapiens skin* | human_skin | 2.9 | 392 | 4.6 | 0.9 |[link](https://zenodo.org/records/10719613)
| *Mus musculus* | mouse_gut | 5.0 | 1252 | 10.3 | 3.4 |[link](https://zenodo.org/records/10719617)
| *Oryctolagus cuniculus* | rabbit_gut | 5.7 | 1053 | 11.1 | 3.5 |[link](https://zenodo.org/records/10719606)
| *Rattus norvegicus* | rat_gut | 5.9 | 1627 | 8.4 | 2.0 |[link](https://zenodo.org/records/10719596)
| *Sus domesticus* | pig_gut | 9.3 | 1523 | 8.4 | 378 |[link](https://zenodo.org/records/10719591)
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 <br />
Illumina_lib1-**SAMPLE_02**.fastq <br />
Illumina_lib2-**SAMPLE_01**.fastq <br />
Illumina_lib2-**SAMPLE_02**.fastq <br />
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 raw 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](https://academic.oup.com/bioinformatics/article/35/9/1544/5106712), and are functionnaly annotated against [KEGG r107](https://academic.oup.com/nar/article/36/suppl_1/D480/2507484), [DBcan](https://academic.oup.com/nar/article/51/W1/W115/7147496?login=true) (carbohydate active enzymes) and [MUSTARD](https://www.nature.com/articles/s41564-018-0292-6) (antibiotic resistant determinants).
MSP and functional profiles are computed from the gene count table with the following command:
```
meteor profile -i <mappingdir> -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:
- species abundance table;
- ARD abundance table (full catalogue only);
- DBCAN abundance table (full catalogue only);
- Gut Metabolic Modules ([GMM](https://www.nature.com/articles/nmicrobiol201688)) abundance table (from the KO annotation) (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> --fast
```
The '--fast' parameter prevent merging of the gene count tables, so that only species and functions table will be merged.
### 5. Strain profiling
-------------------------
## 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
Raw data
{
"_id": null,
"home_page": "https://github.com/metagenopolis/meteor",
"name": "meteor",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "Metagenomics",
"author": "Amine Ghozlane",
"author_email": "amine.ghozlane@pasteur.fr",
"download_url": "https://files.pythonhosted.org/packages/b2/88/6f050036bd65409068bac01c72f8ea52277bcbed6cd4902b9b112dfb8f0c/meteor-2.0.9.tar.gz",
"platform": null,
"description": "# Meteor\n\n[](https://anaconda.org/aghozlane/meteor)\n[](https://pypi.org/project/meteor/)\n[](https://hub.docker.com/r/aghozlane/meteor/)\n\n[](https://codecov.io/gh/metagenopolis/meteor)\n[](https://zenodo.org/doi/10.5281/zenodo.10912587)\n\n## Introduction\n\nMeteor is a plateform for quantitative metagenomics profiling of complex ecosystems.\nMeteor relies on genes catalogue to perform species-level taxonomic profiling, functional analysis and strain-level population structure inference.\n\n\n## Dependencies\n\nBesides python packages dependencies, Meteor requires:\n- python 3.10+\n- [bowtie2 2.3.5+](https://github.com/BenLangmead/bowtie2)\n- [bcftools 0.1.19+](https://samtools.github.io/bcftools/)\n- [bedtools 2.18.0+](https://bedtools.readthedocs.io/en/latest/index.html)\n- [FastTree 1.9.0+](http://www.microbesonline.org/fasttree/)\n\n## Installation\n\nMeteor is available with conda which includes all its dependencies:\n```\nconda create --name meteor -c conda-forge -c bioconda -c aghozlane meteor\n```\n\nOr with pip with a recent Python 3.10+:\n```\npip install meteor\n```\nYou can test the installation of meteor with:\n```\nmeteor test\n```\n## Getting started\n\nA basic usage of meteor will require to:\n1. **Download or build a reference catalogue**\n2. **Structure the raw fastq files**\n3. **Map reads against the reference catalogue**\n4. **Compute taxonomical and/or functional abundances**\n5. **Strain profiling**\n\n### 1. Download or build a custom reference\n-------------------------------------------\n\nMeteor 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.\n\nTen catalogues are currently available:\n\n| Microbial gene catalogue | \\<name\\> | Genes count (M) | Metagenomic Species Pan-genomes (MSPs) |Size (full) (GB) | Size (light) (GB) | Description |\n|:---|:---:|:---:|:---:|:---:|:---:|:---:|\n| *Felis catus* | cat_gut | 1.3 | 344 | 2.7 | 0.9 |[link](https://zenodo.org/records/10719585)\n| *Gallus gallus domesticus* | chicken_caecal | 13.6 | 2420 | 22.8 | 4.8 |[link](https://zenodo.org/records/10719564)\n| *Canis lupus familiaris* | dog_gut | 0.95 | 234 | 1.7 | 0.3 |[link](https://zenodo.org/records/10719585)\n| *Homo sapiens gut* | human_gut | 10.4 | 1990 | 15.1 | 3.2 |[link](https://zenodo.org/records/10719553)\n| *Homo sapiens oral* | human_oral | 8.4 | 853 | 16.4 | 3.2 |[link](https://zenodo.org/records/10719586)\n| *Homo sapiens skin* | human_skin | 2.9 | 392 | 4.6 | 0.9 |[link](https://zenodo.org/records/10719613)\n| *Mus musculus* | mouse_gut | 5.0 | 1252 | 10.3 | 3.4 |[link](https://zenodo.org/records/10719617)\n| *Oryctolagus cuniculus* | rabbit_gut | 5.7 | 1053 | 11.1 | 3.5 |[link](https://zenodo.org/records/10719606)\n| *Rattus norvegicus* | rat_gut | 5.9 | 1627 | 8.4 | 2.0 |[link](https://zenodo.org/records/10719596)\n| *Sus domesticus* | pig_gut | 9.3 | 1523 | 8.4 | 378 |[link](https://zenodo.org/records/10719591)\n\nThese references can be downloaded with the following command:\n```\nmeteor download -i <name> -c -o <refdir>\n```\nThe 'light' catalogues are available with the tag (--fast) :\n```\nmeteor download -i <name> -c --fast -o <refdir>\n```\n\nUsers can also import custom gene catalogue with the command:\n```\nmeteor build -i <fastafile> -n <name> -o <refdir> -t <threads>\n```\n\n### 2. Import fastq\n-------------------\nMeteor requires a first of fastq indexing:\n```\nmeteor fastq -i <fastqdir> [-p paired reads] -n <projectname> -o <outputdir>\n```\nWhen multiple sequencing are available for a library, the option -m allows to group these samples.\nExample:\n\nIllumina_lib1-**SAMPLE_01**.fastq <br />\nIllumina_lib1-**SAMPLE_02**.fastq <br />\nIllumina_lib2-**SAMPLE_01**.fastq <br />\nIllumina_lib2-**SAMPLE_02**.fastq <br />\n\nIn this case, the following command will group these samples the same library:\n```\nmeteor fastq -i ./ -m SAMPLE_\\\\d+ -n projectname -o outputdir\n```\n\n### 3. Mapping\n----------------\nThe raw fastq files are mapped against a catalogue to generate a gene count table with the following command:\n```\nmeteor mapping -i <fastqdir/sampledir> -r <refdir> -o <mappingdir>\n```\nWe recommend to first filter out reads with low-quality, length < 60nt or belonging to the host.\n\n### 4. Taxonomic and functional profiling\n-------------------------\n\nGenes from the catalogue are clustered into Metagenomic Species Pangeomes (MSP) with [MSPminer](https://academic.oup.com/bioinformatics/article/35/9/1544/5106712), and are functionnaly annotated against [KEGG r107](https://academic.oup.com/nar/article/36/suppl_1/D480/2507484), [DBcan](https://academic.oup.com/nar/article/51/W1/W115/7147496?login=true) (carbohydate active enzymes) and [MUSTARD](https://www.nature.com/articles/s41564-018-0292-6) (antibiotic resistant determinants).\n\n MSP and functional profiles are computed from the gene count table with the following command:\n\n```\nmeteor profile -i <mappingdir> -o <profiledir> -r <refdir> -n coverage\n```\n\nThe \"-n\" parameter ensures read count normalization for gene length. If omitted, no normalization will be performed on the gene table.\n\nThis profiling step will generate:\n- species abundance table;\n- ARD abundance table (full catalogue only);\n- DBCAN abundance table (full catalogue only);\n- Gut Metabolic Modules ([GMM](https://www.nature.com/articles/nmicrobiol201688)) abundance table (from the KO annotation) (full catalogue only).\n\n\n### 5. Merging\n\nTo merge output from different samples into a single table, use the following command:\n\n```\nmeteor merge -i <profiledir> -o <mergingdir> --fast\n```\n\nThe '--fast' parameter prevent merging of the gene count tables, so that only species and functions table will be merged.\n\n### 5. Strain profiling\n-------------------------\n\n\n## The METEOR team\nThe main contributors to METEOR:\n\n* Franck Gauthier\n* Amine Ghozlane\n* Florian Plaza O\u00f1ate\n* Nicolas Pons\n* Florence Thirion\n\n\n## Acknowledgements\nSpecial thanks to the following people:\n* Mathieu Almeida\n* Emmanuelle Le Chatelier\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Meteor - A plateform for quantitative metagenomic profiling of complex ecosystems",
"version": "2.0.9",
"project_urls": {
"Homepage": "https://github.com/metagenopolis/meteor",
"Repository": "https://github.com/metagenopolis/meteor"
},
"split_keywords": [
"metagenomics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "718ea21b97a764f926a9c959cfd67f00580e3146ffb768b7257b4eeffc835c08",
"md5": "be0f53e7855e13aaa82d23b49f714e43",
"sha256": "b66b97bae1aa296844aa5e6d4620a91fb0ceaf6a17e99788a130fa17964e68ac"
},
"downloads": -1,
"filename": "meteor-2.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be0f53e7855e13aaa82d23b49f714e43",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 65523027,
"upload_time": "2024-04-16T09:11:28",
"upload_time_iso_8601": "2024-04-16T09:11:28.539951Z",
"url": "https://files.pythonhosted.org/packages/71/8e/a21b97a764f926a9c959cfd67f00580e3146ffb768b7257b4eeffc835c08/meteor-2.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b2886f050036bd65409068bac01c72f8ea52277bcbed6cd4902b9b112dfb8f0c",
"md5": "58a9deaab547708beb888530ebcae278",
"sha256": "853322bfd38e3c3d4af7a999e035c958c43e4f93a31ce6cc221f3f760fecdbdf"
},
"downloads": -1,
"filename": "meteor-2.0.9.tar.gz",
"has_sig": false,
"md5_digest": "58a9deaab547708beb888530ebcae278",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 64959826,
"upload_time": "2024-04-16T09:11:33",
"upload_time_iso_8601": "2024-04-16T09:11:33.718516Z",
"url": "https://files.pythonhosted.org/packages/b2/88/6f050036bd65409068bac01c72f8ea52277bcbed6cd4902b9b112dfb8f0c/meteor-2.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 09:11:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "metagenopolis",
"github_project": "meteor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "meteor"
}
JSON
