anvi-meta-pan-genome

Convert a pangenome into a metapangenome.

🔙 To the main page of anvi’o programs and artifacts.

Authors

Requires

internal-genomes pan-db genomes-storage-db

Provides

metapangenome

Usage

This program integrates the information from an internal-genomes artifact into a pan-db, creating a metapangenome.

A metapangenome contains both the information in a metagenome (i.e. their abundances in different samples as described in your profile-db) and the information in a pangenome (i.e. the gene clusters in your dataset). This is useful because you are able to observe which gene cluster patterns are present in certain environments. For an example of a metapangenomic workflow, take a look here (this tutorial was written before this program, but the insights persist).

To use this program, provide a pan-db and genomes-storage-db pair, as well as an internal-genomes.

anvi-meta-pan-genome -p pan-db \ -g genomes-storage-db \ -i internal-genomes

However, when integrating metagenomic and pangenomic data together, you’ll get a lot of data. You can set two additional parameters to help you filter out data that doesn’t mean certain standards:

  • --fraction-of-median-coverage: this threshold removes genes with less than this fraction of the median coverage. The default is 0.25. So, for example, if the median coverage in your data was 100X, this would remove all genes with coverage less than 25X.
  • --min-detection: this threshold removes genomes with detection less than this value in all samples. The default is 0.5.

Edit this file to update this information.

Command line interface

The following is the list of parameters and their descriptions in the latest version of anvi-meta-pan-genome.

The code that generates this web page ensures that this information is the latest available in 9-dev (eunice). Which means, in some cases the information in this section (generated automatically) might be more comprehensive or up-to-date compared to the descriptions above (written by humans).


Command line usage

anvi-meta-pan-genome [-h] -p PAN_DB [-g GENOMES_STORAGE] [-i FILE] [--fraction-of-median-coverage FLOAT] [--min-detection FLOAT] [--gene-caller GENE-CALLER] [--skip-checking-genome-hashes]

Parameters and their descriptions

PANGENOME Files for the pangenome.
-p, --pan-db PAN_DB required
Anvi'o pan database
-g, --genomes-storage GENOMES_STORAGE
Anvi'o genomes storage file
METAGENOME Genome bins stored in an anvi'o profile databases as collections.
-i, --internal-genomes FILE
A four-column TAB-delimited flat text file. This file should be identical to the internal genomes file you used for your pangenomics analysis. Anvi'o will use this file to find all profile and contigs databases that contain the information for each gene and genome across metagenomes.
CRITERION FOR DETECTION This is tricky. What we want to do is to identify genes that are occurring uniformly across samples.
--fraction-of-median-coverage FLOAT
The value set here will be used to remove a gene if its total coverage across environments is less than the median coverage of all genes multiplied by this value. The default is 0.25, which means, if the median total coverage of all genes across all samples is 100X, then, a gene with a total coverage of less than 25X across all samples will be assumed not a part of the 'environmental core'. Default: 0.25
--min-detection FLOAT
For this entire thing to work, the genome you are focusing on should be detected in at least one metagenome. If that is not the case, it would mean that you do not have any sample that represents the niche for this organism (or you do not have enough depth of coverage) to investigate the detection of genes in the environment. By default, this script requires at least '0.5' of the genome to be detected in at least one metagenome. This parameter allows you to change that. 0 would mean no detection test required, 1 would mean the entire genome must be detected. Default: 0.5
PRO STUFF Things you may not have to change unless you are doing something extra cool and edgy.
--gene-caller GENE-CALLER
The gene caller to utilize. Anvi'o supports multiple gene callers, and some operations (including this one) may require an explicit mentioning of which one to use. The default gene caller is identified automatically in most cases (based on whether the most frequent gene calls match to a known gene caller in anvi'o), but if you have a contigs-db generated with `--external-gene-callers` or something, you may have to pay extra attention here. Also, some HMM collections may add new gene calls into a given contigs-db as an ad-hoc fashion, so if you want to see all the options available to you in a given contigs database, please run the program `anvi-db-info` and take a look at the output.
--skip-checking-genome-hashes
Use this flag if you would like anvi'o to skip checking genome hashes. This is only relevant if you may have genomes in your internal or external genomes files that have identical sequences with different names AND if you are OK with it. You may be OK with it, for instance, if you are using `anvi-dereplicate-genomes` program to dereplicate genomes desribed in multiple collections in an anvi'o profile database that may be describing the same genome multiple times (see https://github.com/merenlab/anvio/issues/1397 for a case).

Additional Resources

Are you aware of resources that may help users better understand the utility of this program? Please feel free to edit this file on GitHub. If you are not sure how to do that, find the __resources__ tag in this file to see an example.