anvi-init-bam

Sort/Index BAM files.

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

Authors

Requires

raw-bam-file

Provides

bam-file

Usage

This program sorts and indexes your BAM files, essentially converting a raw-bam-file into a bam-file, which are ready to be used in anvi’o.

If you’re unsure what a BAM file is, check out the bam-file page or this file, written by the developers of samtools. For a description of what indexing a BAM file does, check out the page for raw-bam-file.

To run this program, just provide a path to the bam files that you want to index. For example,

anvi-init-bam raw-bam-file

You can also multithread this to shorten runtime with the flag -T followed by the desired number of threads if your system is capable of this.

To see it in action (plus a description on how to run it on an entire folder), check out this page.

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-init-bam.

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-init-bam [-h] [-o FILE_PATH] [-T NUM_THREADS] BAM_FILE

Parameters and their descriptions

positional arguments
BAM_FILE required
BAM file to analyze
options
-o, --output-file FILE_PATH
File path to store results.
-T, --num-threads NUM_THREADS
Maximum number of threads to use for multithreading whenever possible. Very conservatively, the default is 1, unless the environmental variable `ANVIO_THREADS` sets another positive integer. If you use this parameter, it will override `ANVIO_THREADS`. It is a good idea to not exceed the number of CPUs / cores on your system. Plus, please be careful with this option if you are running your commands on a SGE -- if you are clusterizing your runs, and asking for multiple threads to use, you may deplete your resources very fast. Default: 1

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.