anvi-report-linkmers

Reports sequences stored in one or more BAM files that cover one of more specific nucleotide positions in a reference.

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

Authors

Requires

bam-file

Provides

linkmers-txt

Usage

Reports sequences stored in a bam-file file that cover one of more specific nucleotide positions in a reference.

Basic mode of operation

Assume you wish to recover reads stored in one or more BAM files, where the matching reads contain at least one nucleotide position that align to a nucleotide position nucleotide_position_N in a contig contig_name_X. In that case, the user would first generate a two column TAB-delmited file, for example positions_for_linkmers.txt with no header line,

contig_name_X nucleotide_position_N

And run the program this way to recover the short reads from this way:

anvi-report-linkmers --contigs-and-positions positions_for_linkmers.txt \
                     -i SAMPLE_01.bam SAMPLE_02.bam SAMPLE_03.bam (...) \
                     -o linkmers.txt

The user can define multiple contigs in the input file, and one or more nucleotide positions for each one of them:

contig_name_X nucleotide_position_01,nucleotide_position_02,nucleotide_position_03
contig_name_Y nucleotide_position_04
contig_name_Z nucleotide_position_05,nucleotide_position_06

The resulting linkmers-txt would include all short reads that match any of these critera

Using the --only-complete-links flag, the user can enforce whether only complete links should be reported where each reported short read must cover each nucleotide position for a given contig.

Please note that if the nucleotide positions chosen for a given contig are too distant from each other given the short read length, zero reads may satisfy the complete links criterion.

Having complete links, however, will enable oligotyping analyses on metagenomic reads through the anvi’o program anvi-oligotype-linkmers.

See this program in action

http://merenlab.org/2015/12/09/musings-over-commamox/

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-report-linkmers.

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-report-linkmers [-h] -i INPUT_BAM(S) [INPUT_BAM(S) ...] --contigs-and-positions CONTIGS_AND_POS [--only-complete-links] -o FILE_PATH [--list-contigs]

Parameters and their descriptions

options
-i, --input-files INPUT_BAM(S) required
Sorted and indexed BAM files to analyze. It is essential that all BAM files must be the result of mappings against the same contigs.
--contigs-and-positions CONTIGS_AND_POS required
This is the file where you list the contigs, and nucleotide positions you are interested in. This is supposed to be a TAB-delimited file with two columns. In each line, the first column should be the contig name, and the second column should be the comma-separated list of integers for nucleotide positions.
When declared, only reads that cover all positions will be reported. It is necessary to use this flag if you want to perform oligotyping-like analyses on matching reads.
-o, --output-file FILE_PATH required
File path to store results.
--list-contigs
When declared, the program will list contigs in the BAM file and exit gracefully without any further analysis.

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.