anvi-update-db-description

Update the description in an anvi'o database.

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

Authors

A. Murat Eren (Meren)
WebEmailTwitterGithub

Requires

contigs-db

Can use

pan-db pan-graph-db profile-db genomes-storage-db

Provides

This program does not seem to provide any artifacts. Such programs usually print out some information for you to see or alter some anvi’o artifacts without producing any immediate outputs.

Usage

This program allows you to update the description of any anvi’o database with the push of a button (and the writing of an updated description).

This descirption helps make UIs a little prettier by showing up when you run programs like anvi-interactive and anvi-summarize.

Simply write out the description that you would prefer in a plain text file (with markdown syntax) and use this program to update the description of any pan-db, profile-db, contigs-db, or genomes-storage-db:

anvi-update-db-description --description my_description.txt \ contigs-db

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-update-db-description.

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-update-db-description [-h] --description TEXT_FILE DB

Parameters and their descriptions

positional arguments
DB required
An anvi'o database.
options
--description TEXT_FILE required
A plain text file that contains some description about the project. You can use Markdown syntax. The description text will be rendered and shown in all relevant interfaces, including the anvi'o interactive interface, or anvi'o summary outputs.

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.

Copyleft, The anvi'o Project