Mercurial > repos > nilesh > rseqc

annotate bam_stat.xml @ 43:378d05d35705 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author lparsons
date Wed, 23 Jul 2014 10:58:28 -0400
parents 1e66f05a23aa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
40
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
1 <tool id="rseqc_bam_stat" name="BAM/SAM Mapping Stats" version="2.3.9">
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
2 <description>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
3 reads mapping statistics for a provided BAM or SAM file.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
4 </description>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
5 <requirements>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
6 <requirement type="package" version="1.7.1">numpy</requirement>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
7 <requirement type="package" version="2.3.9">rseqc</requirement>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
8 </requirements>s
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
9 <command>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
10 bam_stat.py -i $input -q $mapqual 2> $output
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
11 </command>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
12 <stdio>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
13 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
14 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
15 </stdio>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
16 <inputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
17 <param name="input" type="data" label="Input .bam/.sam File" format="bam,sam" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
18 <param label="Minimum mapping quality (default=30" type="integer" value="30" name="mapqual" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
19 </inputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
20 <outputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
21 <data format="txt" name="output" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
22 </outputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
23 <help>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
24 bam_stat.py
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
25 +++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
26
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
27 This program is used to calculate reads mapping statistics from provided BAM
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
28 file. This script determines "uniquely mapped reads" from `mapping quality`_,
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
29 which quality the probability that a read is misplaced (Do NOT confused with
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
30 sequence quality, sequence quality measures the probability that a base-calling
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
31 was wrong) .
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
32
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
33 Inputs
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
34 ++++++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
35
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
36 Input BAM/SAM file
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
37 Alignment file in BAM/SAM format.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
38
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
39 Minimum mapping quality
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
40 Minimum mapping quality for an alignment to be called “uniquely mapped” (default=30)
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
41
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
42 Output
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
43 ++++++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
44
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
45 - Total Reads (Total records) = {Multiple mapped reads} + {Uniquely mapped}
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
46 - Uniquely mapped Reads = {read-1} + {read-2} (if paired end)
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
47 - Uniquely mapped Reads = {Reads map to '+'} + {Reads map to '-'}
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
48 - Uniquely mapped Reads = {Splice reads} + {Non-splice reads}
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
49
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
50 -----
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
51
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
52 About RSeQC
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
53 +++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
54
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
55 The RSeQC_ package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. "Basic modules" quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while "RNA-seq specific modules" investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
56
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
57 The RSeQC package is licensed under the GNU GPL v3 license.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
58
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
59 .. image:: http://rseqc.sourceforge.net/_static/logo.png
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
60
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
61 .. _RSeQC: http://rseqc.sourceforge.net/
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
62 .. _`mapping quality`: http://genome.sph.umich.edu/wiki/Mapping_Quality_Scores
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
63
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
64 </help>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
65 </tool>