anvi-import-items-order

Import a new items order into an anvi'o database.

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

Authors

Requires

profile-db misc-data-items-order-txt

Can use

pan-db dendrogram phylogeny

Provides

misc-data-items-order

Usage

This program, as one might think, allows you to import a misc-data-items-order-txt to describe a specific order of items stored in a profile-db, pan-db, or genes-db.

anvi-import-items-order -p profile-db \ -i misc-data-items-order-txt

It may also be nice to give it a good name, so that it’s easy to find in the interface.

anvi-import-items-order -p profile-db \ -i misc-data-items-order-txt \ --name ORDER_NAME

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-import-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-import-items-order [-h] [-i FILE] [-p DB PATH] [--name ORDER NAME] [--make-default]

Parameters and their descriptions

CRITICAL INPUT Basically the input file and the target database
-i, --input-order FILE
One of the two important things you must provide: the file that contains the items order. The format of this file is important. It can either contain a proper newick tree in it, or a complete list of 'items' in the target database where every line of the file is simply an item name. If you are providing a newick tree, the entire file should be a single line. I know it sounds hard, but you seriously can do this.
-p, --db-path DB PATH
An appropriate anvi'o database to import the items order. Currently it can be a profile, pan, or genes database. But you should try your chances with other kinds of databases for fun and games. Basically, if the database contains an items order table, then things will work. Otherwise, you will probably get angry errors back in the worst case scenario.
NOT SO CRITICAL INPUT Because not all parameters are created equal
--name ORDER NAME
What should we call this order? Give it a concise, single-word name.
--make-default
You have the option to make this order the default order in the database. Which means, anvi'o will use this one when someone runs the program anvi-interactive and presses draw. Big responsibility. But if you have a 'default' state, it will not work because the default items order in the state file overwrites the one that comes from the database. So not that big of a responsibility.

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.