annotate BAMqc.xml @ 5:0c5c414c3407

Uploaded
author cshl-bsr
date Tue, 29 Mar 2016 15:33:54 -0400
parents f98435398c1d
children 736260d32237
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
1 <tool id="cshl_BAMqc" name="ezBAMQC" version="0.6.7" >
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
2
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
3 <description>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
4 performs QC on BAM files for gene abundances and sample correlation
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
5 </description>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
6
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
7 <requirements>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
8 <requirement type="package">BAMqc</requirement>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
9 <requirement type="package">samtools</requirement>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
10 <requirement type="package">R</requirement>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
11 </requirements>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
12
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
13 <command interpreter="sh">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
14
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
15 BAMqc.sh
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
16
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
17 -r '${refdb}'
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
18
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
19 -f '${attrID}'
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
20
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
21 -R '${rRNAdb}'
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
22
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
23 -s '$stranded'
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
24
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
25 -o "$output"
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
26
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
27 #set $core = len($files)
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
28
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
29 -p $core
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
30
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
31 #if str($cond_adv_options.adv_options) == 'yes':
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
32 -q '$cond_adv_options.mapq'
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
33 #end if
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
34
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
35 #for $file in $files
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
36 '$file.input'
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
37 '$file.input.tag'
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
38 #end for
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
39
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
40 </command>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
41
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
42 <inputs>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
43 <repeat name="files" title="BAM files" min="1">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
44 <param format="bam" name="input" type="data" label="Files for QC" />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
45 </repeat>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
46
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
47 <param name="refdb" type="select" label="Reference gene model (GTF)">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
48 <options from_data_table="gene_GTF_database" />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
49 </param>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
50
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
51 <param name="attrID" type="text" size="50" value="gene_id" label="Feature ID name" help="Summing reads based on gene (gene_id) or transcript (transcript_id.">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
52 <sanitizer>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
53 <valid initial="none">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
54 <add value="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz01234567890_-." />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
55 </valid>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
56 </sanitizer>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
57 </param>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
58
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
59 <param name="rRNAdb" type="select" label="Ribosomal RNA locations (BED)">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
60 <options from_data_table="rRNA_BED_database" />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
61 </param>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
62
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
63 <param name="stranded" type="select" label="Strandedness">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
64 <option value="yes">Yes - Read from stranded library</option>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
65 <option value="no">No - Reads from unstranded library</option>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
66 <option value="reverse">Reverse - reverse-stranded library (e.g. NSR)</option>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
67 </param>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
68
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
69 <conditional name="cond_adv_options">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
70 <param name="adv_options" type="select" label="Set advanced options">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
71 <option value="no" selected="true">No</option>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
72 <option value="yes">Yes</option>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
73 </param>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
74
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
75 <when value="yes">
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
76 <param name="mapq" type="integer" value="30" label="Minimum mapping quality for an alignment to be called uniquely mapped" />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
77 </when>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
78
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
79 <when value="no" />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
80 </conditional>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
81
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
82 </inputs>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
83
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
84 <outputs>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
85 <data format="html" name="output" label="BAM QC on $on_tag_string" />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
86 <data format="txt" name="log" from_work_dir="bamqc.log" label="ezBAMQC log output" hidden="True" />
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
87 </outputs>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
88
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
89 <help>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
90
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
91 **What it does**
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
92
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
93 This tool takes the mapping results from RNA-Seq libraries (BAM), and performs rapid gene abundance quantification. If multiple files are provided, it will calculate and display correlation between each sample.
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
94
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
95 -----
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
96
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
97 The Galaxy wrapper for this tool is written by the `Cold Spring Harbor Laboratory`_ `Bioinformatics Shared Resources`_.
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
98
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
99 ezBAMQC_ is written by the `Molly Hammell Laboratory`_ and the `Bioinformatics Shared Resources`_ at CSHL_.
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
100
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
101 .. _CSHL: `Cold Spring Harbor Laboratory`_
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
102 .. _ezBAMQC: http://hammelllab.labsites.cshl.edu/software#ezBAMQC
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
103 .. _`Molly Hammell Laboratory`: http://hammelllab.labsites.cshl.edu/
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
104 .. _`Cold Spring Harbor Laboratory`: http://www.cshl.edu/
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
105 .. _`Bioinformatics Shared Resources`: http://bioinfo.cshl.edu/index.html
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
106
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
107 </help>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
108 </tool>
f98435398c1d Uploaded
cshl-bsr
parents:
diff changeset
109