annotate sam-stats.xml @ 1:cf4b5125a835 draft

Uploaded
author lparsons
date Tue, 20 Nov 2012 15:54:14 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
1 <tool id="sam_stats" name="sam-stats" version="0.1">
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
2 <description> - Compute statistics from SAM or BAM files</description>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
3 <requirements>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
4 <requirement type="package" version="1.1.2-484">ea-utils</requirement>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
5 </requirements>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
6 <command>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
7 sam-stats
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
8 $trackMultAlign
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
9 $reportAllChr
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
10 #if $rnaSeqStats:
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
11 -R $rnaSeqStatsFile
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
12 #end if
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
13 #if $input.extension == "bam":
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
14 -B
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
15 #end if
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
16 -S $histBinSize
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
17 $input
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
18 &gt; $samStats
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
19 </command>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
20 <inputs>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
21 <param format="sam, bam" name="input" type="data" label="SAM/BAM File" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
22 <param name="trackMultAlign" type="boolean" value="False" truevalue="-D" falsevalue="" label="Keep track of multiple alignments (slower!)" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
23 <param name="reportAllChr" type="boolean" value="False" truevalue="-A" falsevalue="" label="Report all chr sigs, even if there are more than 1000" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
24 <!-- <param name="numReadsSubsample" type="integer" value="1000000" min="1" max="1000000" label="Number of reads to sample for per-base statistics (max 1,000,000)" /> -->
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
25 <param name="histBinSize" type="integer" value="30" min="1" label="Number of bins per chromosome for reads by chromosome &quot;histogram&quot;" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
26 <param name="rnaSeqStats" type="boolean" value="False" label="Output RNA-Seq statistics (coverage, 3 prime bias, etc.)" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
27 </inputs>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
28
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
29 <outputs>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
30 <data format="tabular" name="samStats" label="${tool.name} on ${on_string}"/>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
31 <data format="tabular" name="rnaSeqStatsFile" label="${tool.name} on ${on_string} (RNA-Seq Stats)"> <filter>rnaSeqStats</filter>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
32 </data>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
33 </outputs>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
34
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
35 <stdio>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
36 <exit_code range="1:" level="fatal" description="Unknown error occurred" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
37 </stdio>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
38
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
39 <tests>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
40 <test>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
41 <param name="input" value="test.sam" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
42 <output name="samStats" file="testout.txt" />
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
43 </test>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
44 </tests>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
45
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
46 <help>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
47 Overview
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
48 --------
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
49 sam-stats computes varius statics on SAM/BAM alignment files.
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
50
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
51 Complete Stats::
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
52
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
53 &lt;STATS&gt; : mean, max, stdev, median, Q1 (25 percentile), Q3
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
54 reads : # of entries in the sam file, might not be # reads
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
55 phred : phred scale used
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
56 bsize : # reads used for qual stats
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
57 mapped reads : number of aligned reads (unique probe id sequences)
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
58 mapped bases : total of the lengths of the aligned reads
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
59 forward : number of forward-aligned reads
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
60 reverse : number of reverse-aligned reads
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
61 snp rate : mismatched bases / total bases
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
62 ins rate : insert bases / total bases
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
63 del rate : deleted bases / total bases
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
64 pct mismatch : percent of reads that have mismatches
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
65 len &lt;STATS&gt; : read length stats, ignored if fixed-length
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
66 mapq &lt;STATS&gt; : stats for mapping qualities
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
67 insert &lt;STATS&gt; : stats for insert sizes
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
68 &lt;CHR&gt; : percentage of mapped bases per chr, followed by a signature
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
69
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
70 Subsampled stats (1M reads max)::
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
71
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
72 base qual &lt;STATS&gt; : stats for base qualities
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
73 A,T,C,G : base percentages
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
74
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
75 Meaning of the per-chromosome signature:
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
76
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
77 A ascii-histogram of mapped reads by chromosome position. It is only output if the original SAM/BAM has a header. The values are the log2 of the # of mapped reads at each position + ascii '0'.
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
78
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
79 See http://code.google.com/p/ea-utils/wiki/SamStatsDetails for more information on each stat, how it's calculated and what it means.
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
80
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
81 This tool uses the sam-stats program that is part of the ea-utils suite. See http://code.google.com/p/ea-utils/wiki/SamStats for details.
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
82 </help>
cf4b5125a835 Uploaded
lparsons
parents:
diff changeset
83 </tool>