anvi-delete-collection

Remove a collection from a given profile database.

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

Authors

Requires

profile-db collection

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, as implied by the name, will delete a collection from a profile-db or a pan-db.

Using this program will delete the collection and every bin it describes from the database forever and without any additional warning. If you are not sure whether you may need a given collection later, it may be a good idea to export your binning effort into a collection-txt using anvi-export-collection before deleting it, just to be safe.

To list available collections in a database you can use the program anvi-show-collections-and-bins. When you know which collection you wish to remove, you can run the program on the target collection name:

anvi-delete-collection -p profile-db \ -C collection

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-delete-collection.

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-delete-collection [-h] -p PROFILE_DB [-C COLLECTION_NAME] [--list-collections]

Parameters and their descriptions

options
-p, --profile-db PROFILE_DB required
Anvi'o profile database
-C, --collection-name COLLECTION_NAME
Collection name.
--list-collections
Show available collections 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.