anvi-export-items-order

Export an item order from an anvi'o database.

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

Authors

Requires

profile-db

Can use

pan-db

Provides

misc-data-items-order-txt dendrogram phylogeny

Usage

This program, as one might think, allows you to export a misc-data-items-order, outputing a misc-data-items-order-txt.

You can export one of the item orders in a profile-db or pan-db as follows:

anvi-export-items-order -p profile-db \ --name cov

The cov here refers to the tree that is generated using only differential coverage. Almost all anvi’o profile databases will also have available an items-order based on the tetranucleotide frequency called tnf, and one based on both called tnf-cov.

However, to list the item orders available in this database, just don’t include the name flag.

anvi-export-items-order -p pan-db

You’ll get a Config Error that will tell you what item orders are available.

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-export-items-order.

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-export-items-order [-h] [-p DB PATH] [--name ORDER NAME] [-o FILE_PATH]

Parameters and their descriptions

INPUT The database and the items order of interest
-p, --db-path DB PATH
An appropriate anvi'o database.
--name ORDER NAME
The name of the order you want to export. If you don't provide an order name, anvi'o will show you the names of all available orders in the database.
OUPUT Output file name and stuff
-o, --output-file FILE_PATH
File path to store results.

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.