Mercurial > repos > nilesh > rseqc
annotate read_quality.xml @ 33:073c77ce5e94
export PYTHONPATH during install, note python 2.7 requirement
| author | lparsons |
|---|---|
| date | Tue, 15 Oct 2013 12:58:55 -0400 |
| parents | 580ee0c4bc4e |
| children |
| rev | line source |
|---|---|
|
32
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
1 <tool id="rseqc_read_quality" name="Read Quality" version="1.1"> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
2 <description>determines Phred quality score</description> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
3 <requirements> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
4 <requirement type="package" version="3.0.1">R</requirement> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
5 <requirement type="package" version="1.7.1">numpy</requirement> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
6 <requirement type="package" version="2.3.7">rseqc</requirement> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
7 </requirements> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
8 <command> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
9 read_quality.py -i $input -o output -r $reduce |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
10 </command> |
| 31 | 11 <stdio> |
| 12 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" /> | |
| 13 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" /> | |
| 14 </stdio> | |
|
32
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
15 <inputs> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
16 <param name="input" type="data" format="bam,sam" label="input bam/sam file" /> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
17 <param name="reduce" type="integer" label="Ignore Phred scores less than this amount (only applies to 'boxplot', default=1000)" value="1000" /> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
18 </inputs> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
19 <outputs> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
20 <data format="txt" name="outputr" from_work_dir="output.qual.r" label="${tool.name} on ${on_string} (R Script)" /> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
21 <data format="pdf" name="outputpdf" from_work_dir="output.qual.heatmap.pdf" label="${tool.name} on ${on_string} (Heatmap PDF)" /> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
22 <data format="pdf" name="outputpdf" from_work_dir="output.qual.boxplot.pdf" label="${tool.name} on ${on_string} (Boxplot PDF)" /> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
23 </outputs> |
|
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
24 <help> |
| 31 | 25 read_quality.py |
| 26 +++++++++++++++ | |
| 29 | 27 |
| 31 | 28 According to SAM specification, if Q is the character to represent "base calling quality" |
| 29 in SAM file, then Phred Quality Score = ord(Q) - 33. Here ord() is python function that | |
| 30 returns an integer representing the Unicode code point of the character when the argument | |
| 31 is a unicode object, for example, ord('a') returns 97. Phred quality score is widely used | |
| 32 to measure "reliability" of base-calling, for example, phred quality score of 20 means | |
| 33 there is 1/100 chance that the base-calling is wrong, phred quality score of 30 means there | |
| 34 is 1/1000 chance that the base-calling is wrong. In general: Phred quality score = -10xlog(10)P, | |
| 35 here P is probability that base-calling is wrong. | |
| 29 | 36 |
| 37 Inputs | |
| 38 ++++++++++++++ | |
| 39 | |
| 40 Input BAM/SAM file | |
|
32
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
41 Alignment file in BAM/SAM format. |
| 29 | 42 |
| 43 Ignore phred scores less than this number (default=1000) | |
|
32
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
44 To avoid making huge vector in R, nucleotide with certain phred score represented less than this number will be ignored. Increase this number save more memory while reduce precision. This option only applies to the 'boxplot'. |
| 29 | 45 |
| 46 Output | |
| 47 ++++++++++++++ | |
| 48 | |
| 49 1. output.qual.r | |
| 50 2. output.qual.boxplot.pdf | |
| 31 | 51 .. image:: http://rseqc.sourceforge.net/_images/36mer.qual.plot.png |
| 52 :height: 600 px | |
| 53 :width: 600 px | |
| 54 :scale: 80 % | |
| 29 | 55 3. output.qual.heatmap.pdf |
| 31 | 56 .. image:: http://rseqc.sourceforge.net/_images/36mer.qual.heatmap.png |
| 57 :height: 600 px | |
| 58 :width: 600 px | |
| 59 :scale: 80 % | |
| 60 | |
| 61 Heatmap: use different color to represent nucleotide density ("blue"=low density,"orange"=median density,"red"=high density") | |
| 62 | |
| 63 ----- | |
| 64 | |
| 65 About RSeQC | |
| 66 +++++++++++ | |
| 67 | |
| 68 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. | |
| 69 | |
| 70 The RSeQC package is licensed under the GNU GPL v3 license. | |
| 71 | |
| 72 .. image:: http://rseqc.sourceforge.net/_static/logo.png | |
| 73 | |
| 74 .. _RSeQC: http://rseqc.sourceforge.net/ | |
| 75 | |
| 29 | 76 |
|
32
580ee0c4bc4e
Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc
lparsons
parents:
31
diff
changeset
|
77 </help> |
| 29 | 78 </tool> |