anvi-export-misc-data

Export additional data or order tables in pan or profile databases for items or layers.

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

Authors

Requires

profile-db

Can use

pan-db contigs-db misc-data-items misc-data-layers misc-data-layer-orders misc-data-nucleotides misc-data-amino-acids

Provides

misc-data-items-txt misc-data-layers-txt misc-data-layer-orders-txt misc-data-nucleotides-txt misc-data-amino-acids-txt

Usage

This program lets you export miscellaneous data of your choosing into a text file, which can be imported into another anvi’o project using anvi-import-misc-data. You can export the same types of data that you can import with that function. These are also listed below.

To see what misc-data is available in your database, use anvi-show-misc-data.

If your misc-data is associated with a specific data group, you can provide that data group to this program with the -D flag. For instance, to export only the homogeneity indices from a pan-db:

anvi-export-misc-data -p pan-db \ --target-data-table items \ -D homogeneity

Several anvi’o programs create named data groups automatically. For items data in a pan database, common groups include gene_cluster_stats, SCG, homogeneity, AAI, functional_annotation, and bayesian_pan_core. See misc-data-items for details.

Data types you can export

From a pan-db or profile-db: items, layers, layer orders

From a pan-db or profile-db, you can export

anvi-export-misc-data -p profile-db \ --target-data-table items

anvi-export-misc-data -p pan-db \ --target-data-table layers

anvi-export-misc-data -p profile-db \ --target-data-table layer_orders

From a contigs-db: nucleotide and amino acid information

From a contigs-db, you can export

anvi-export-misc-data -c contigs-db --target-data-table nucleotides

anvi-export-misc-data -c contigs-db --target-data-table amino_acids

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-misc-data.

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-misc-data [-h] [-p PAN_OR_PROFILE_DB] [-c CONTIGS_DB] -t NAME [-D NAME] [-o FILE_PATH]

Parameters and their descriptions

Database input Provide 1 of these
-p, --pan-or-profile-db PAN_OR_PROFILE_DB
An anvi'o pan-db or profile-db (and even genes-db or pan-graph-db in appropriate contexts).
-c, --contigs-db CONTIGS_DB
Anvi'o contigs database generated by 'anvi-gen-contigs-database'
Details Everything else.
-t, --target-data-table NAME required
The target table is the table you are interested in accessing. Currently it can be 'items','layers', or 'layer_orders'. Please see most up-to-date online documentation for more information.
-D, --target-data-group NAME
Data group to focus. Anvi'o misc data tables support associating a set of data keys with a data group. If you have no idea what this is, then probably you don't need it, and anvi'o will take care of you. Note: this flag is IRRELEVANT if you are working with additional order data tables.
-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.