Microbial 'omics


Brought to you by

anvi-merge [program]

Merge multiple anvio profiles.

See program help menu or go back to the main page of anvi’o programs and artifacts.

Table of Contents

Provides

profile-db misc-data-items-order

Requires or uses

single-profile-db contigs-db

Usage

The main function of anvi-merge is to convert multiple single-profile-dbs into a single profile-db (also called a merged profile database). Basically, this takes the alignment data from each sample (each contained in its own single-profile-db) and combines them into a single database that anvi’o can look through more easily.

Overview: How to run anvi-merge

  1. Set up your contigs-db. See that page for more information

  2. Use anvi-profile to create a single-profile-db for each of your samples (formatted into a bam-file) (Note: for each of these runs, you’ll need to use the same contigs-db and parameters)

  3. Use anvi-merge to merge those single-profile-dbs into a single database, called a profile-db. This will look something like the following:

anvi-merge -c cool_contigs.db \ Single_profile_db_1 Single_profile_db_2 \ -o cool_contigs_merge

This will put all of the output files (the final profile-db as well as a misc-data-items-order which is the result of your hierarchical clustering and describes the order to display your contigs in) into the folder cool_contigs_merge .

Other Parameters

You must give anvi-merge your contigs database and single profile databases. However, you can also provide more information or give addtional instructions. Use the flag -h at any time to display the help menu.

Hierarchical Clustering

To run or not to run?

  • Use the flag --skip-hierarchical-clustering to turn hierarchical clustering off. This will save on computation time, but will skip out on creating the tree of contigs at the center of the interactive interface. If you have more than 25,000 splits in the final profile, this will be set automatically.
  • Use the flag --enforce-hierarchical-clustering to turn hierarchical clustering back on. This will take a long time, but will produce a lovely contigs tree for the interactive interface.

Additional parameters

  • Provide a custom distance metric for clustering using the flag --distance. (The default is euclidean)
  • Provide a custom linkage method for clustering using the flag --linkage. (The default is ward)

Providing additional information

  • Provide the sample name using the flag -S. If you don’t, anvi’o will come up with one, but it probably won’t be any good.
  • Provide a text file in markdown to describe the project using the flag --description. This will show up when you later use the interactive interface to analyze your profile-db.

Output Information

  • Provide an output destination with the flag -o.
  • Add the flag -W to overwrite existing files in that directory.

Edit this file to update this information.

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.