This tool, like many others in Galaxy, is the same as would be used outside of Galaxy. That means the external documentation/usage is generally the same, especially for the outputs.
How to know where to find docs and examples?
Internet search for references, publications, specifications.
Scroll down on the tool form to find available references, including link-outs to author resources and publications.
Sometimes an abbreviated Help section will also be included as a short reference directly on the tool form. The content is usually from the original documentation. This is intended as a supplement and usually addresses any Galaxy-specific details like data formats. Most of what happens at this forum is connecting all of these together.
This is the Help section for this Samtools idx tool, which explains the output along with an example. Review the link-outs for full details.
What it does
Runs the samtools idxstats command. It retrieves and prints stats in the index file.
Input is a sorted and indexed BAM file, the output is tabular with four columns (one row per reference sequence plus a final line for unmapped reads):
1 Reference sequence identifier
2 Reference sequence length
3 Number of mapped reads
4 Number of placed but unmapped reads
(typically unmapped partners of mapped reads)
Example output from a de novo assembly:
contig_1 170035 98397 0
contig_2 403835 199564 0
contig_3 553102 288189 0
… … … …
contig_603 653 50 0
contig_604 214 6 0
* 0 0 50320
In this example there were 604 contigs, each with one line in the output table, plus the final row (labelled with an asterisk) representing 50320 unmapped reads. In this BAM file, the final column was otherwise zero.
The results of samtools ixdstats can be visualized with MultiQC.
Peter J.A. Cock (2013), Galaxy wrapper for the samtools idxstats command
Definition of SAM/BAM format. (n.d.). HTS format specifications
Li, H., Handsaker, B., Wysoker, A., Fennell, T., Ruan, J., Homer, N., Marth, G., Abecasis, G., & Durbin, R. (2009). The Sequence Alignment/Map format and SAMtools. Bioinformatics, 25(16), 2078â2079. Sequence Alignment/Map format and SAMtools | Bioinformatics | Oxford Academic
Li, H. (2011). Improving SNP discovery by base alignment quality. Bioinformatics, 27(8), 1157â1158. Improving SNP discovery by base alignment quality | Bioinformatics | Oxford Academic
Li, H. (2011). A statistical framework for SNP calling, mutation discovery, association mapping and population genetical parameter estimation from sequencing data. Bioinformatics, 27(21), 2987â2993. statistical framework for SNP calling, mutation discovery, association mapping and population genetical parameter estimation from sequencing data | Bioinformatics | Oxford Academic
Danecek. (n.d.). Multiallelic calling model in bcftools (-m). http://samtools.github.io/bcftools/call-m.pdf
Durbin, R. (n.d.). Segregation based metric for variant call QC. http://samtools.github.io/bcftools/rd-SegBias.pdf
Li, H. (n.d.). Mathematical Notes on SAMtools Algorithms. http://www.broadinstitute.org/gatk/media/docs/Samtools.pdf
SAMTools GitHub page. (n.d.). GitHub - samtools/samtools: Tools (written in C using htslib) for manipulating next-generation sequencing data
Requirements See details