anvi-export-state

Authors
Requires
Can use
Provides
Usage
Command line interface

Command line usage
Parameters and their descriptions

Additional Resources

Export an anvi'o state into a profile database.

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

Authors

A. Murat Eren (Meren)

Requires

profile-db

Can use

pan-db state

Provides

state-json

Usage

This program allows you to export a state from a pan-db or profile-db. The output of this is a state-json, which you can import into another anvi’o project with anvi-import-state.

You can run this program on a profile-db or pan-db as follows:

anvi-export-state -s state \ -p profile-db \ -o path/to/output

To list the collections available in this database, you can run

anvi-export-state -p pan-db \ --list-states

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-state.

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-state [-h] -p PAN_OR_PROFILE_DB [-o FILE_PATH] [-s STATE_NAME] [--list-states]

Parameters and their descriptions

options

-p, --pan-or-profile-db PAN_OR_PROFILE_DB required: An anvi'o pan-db or profile-db (and even genes-db or pan-graph-db in appropriate contexts).
-o, --output-file FILE_PATH: File path to store results.
-s, --state STATE_NAME: The state name to export.
--list-states: Show available states and exit.

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.