annotate pyCRAC/pyMotif.xml @ 1:7c9574213c0a draft default tip

Uploaded
author swebb
date Thu, 20 Jun 2013 12:13:43 -0400
parents 19b20927172d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
19b20927172d Uploaded
swebb
parents:
diff changeset
1 <tool id ="pyMotif" name="pyMotif">
19b20927172d Uploaded
swebb
parents:
diff changeset
2 <requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
3 <requirement type="package">pyCRAC</requirement>
19b20927172d Uploaded
swebb
parents:
diff changeset
4 </requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
5 <command interpreter="perl">
19b20927172d Uploaded
swebb
parents:
diff changeset
6 pyMotif.pl
19b20927172d Uploaded
swebb
parents:
diff changeset
7 -f $input
19b20927172d Uploaded
swebb
parents:
diff changeset
8 --gtf=$addGTF.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
9
19b20927172d Uploaded
swebb
parents:
diff changeset
10 #if $addGTF.gtfFile == "default" and $addGTF.annotate.annotations == "auto":
19b20927172d Uploaded
swebb
parents:
diff changeset
11 --annotation $addGTF.annotate.scan.annotation
19b20927172d Uploaded
swebb
parents:
diff changeset
12 #else:
19b20927172d Uploaded
swebb
parents:
diff changeset
13 --annotation $addGTF.annotate.annotation
19b20927172d Uploaded
swebb
parents:
diff changeset
14 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
15
19b20927172d Uploaded
swebb
parents:
diff changeset
16 --tab=$addTab.tab
19b20927172d Uploaded
swebb
parents:
diff changeset
17
19b20927172d Uploaded
swebb
parents:
diff changeset
18 #if $addOpt.options == "edit":
19b20927172d Uploaded
swebb
parents:
diff changeset
19 --options
19b20927172d Uploaded
swebb
parents:
diff changeset
20 --k_min $addOpt.kmin
19b20927172d Uploaded
swebb
parents:
diff changeset
21 --k_max $addOpt.kmax
19b20927172d Uploaded
swebb
parents:
diff changeset
22 --numberofkmers=$addOpt.numberofkmers
19b20927172d Uploaded
swebb
parents:
diff changeset
23 --overlap $addOpt.overlap
19b20927172d Uploaded
swebb
parents:
diff changeset
24 --range $addOpt.range
19b20927172d Uploaded
swebb
parents:
diff changeset
25 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
26 -o "$input.name"
19b20927172d Uploaded
swebb
parents:
diff changeset
27 --id $count.id
19b20927172d Uploaded
swebb
parents:
diff changeset
28 --count $count
19b20927172d Uploaded
swebb
parents:
diff changeset
29 --random $random
19b20927172d Uploaded
swebb
parents:
diff changeset
30 --features $features
19b20927172d Uploaded
swebb
parents:
diff changeset
31 --zscores $zscores
19b20927172d Uploaded
swebb
parents:
diff changeset
32 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
33 <version_command>/usr/local/bin/pyMotif.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
34 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
35 <param format="gtf" name="input" type="data" label="Input File --input_file" help="File of type .gtf" />
19b20927172d Uploaded
swebb
parents:
diff changeset
36 <conditional name="addTab">
19b20927172d Uploaded
swebb
parents:
diff changeset
37 <param name="tabFile" type="select" label="Choose Genomic Reference Sequence from">
19b20927172d Uploaded
swebb
parents:
diff changeset
38 <option value="default" selected="true">Defaults</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
39 <option value="other">History</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
40 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
41 <when value="default">
19b20927172d Uploaded
swebb
parents:
diff changeset
42 <param name="tab" type="select" label="Genomic Reference Sequence --tab" help="Tab file containing genomic reference sequence">
19b20927172d Uploaded
swebb
parents:
diff changeset
43 <options from_data_table="pycrac_tab"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
44 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
45 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
46 <when value="other">
19b20927172d Uploaded
swebb
parents:
diff changeset
47 <param format="tabular" name="tab" type="data" label="Genomic Reference Sequence --tab" help="Tab file containing genomic reference sequence"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
48 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
49 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
50 <conditional name="addGTF">
19b20927172d Uploaded
swebb
parents:
diff changeset
51 <param name="gtfFile" type="select" label="Choose GTF File from">
19b20927172d Uploaded
swebb
parents:
diff changeset
52 <option value="default" selected="true">Defaults</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
53 <option value="other">History</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
54 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
55 <when value="default">
19b20927172d Uploaded
swebb
parents:
diff changeset
56 <param name="gtf" type="select" label="GTF File --gtf" help="GTF file containing gene ID co-ordinates">
19b20927172d Uploaded
swebb
parents:
diff changeset
57 <options from_data_table="pycrac_gtf"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
58 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
59
19b20927172d Uploaded
swebb
parents:
diff changeset
60 <conditional name="annotate">
19b20927172d Uploaded
swebb
parents:
diff changeset
61 <param name="annotations" type="select" label="Select annotation">
19b20927172d Uploaded
swebb
parents:
diff changeset
62 <option value="all" selected="true">All</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
63 <option value="manual">Enter in text box</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
64 <option value="auto">Scan pyGetGTFSources file</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
65 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
66 <when value="all">
19b20927172d Uploaded
swebb
parents:
diff changeset
67 <param name="annotation" type="hidden" format="txt" size="10" value="all"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
68 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
69 <when value="manual">
19b20927172d Uploaded
swebb
parents:
diff changeset
70 <param name="annotation" type="text" format="txt" size="100" value="protein_coding" label="Select which annotation to focus search on --annotation" help="To find a list of available annotations please use pyGetGTFSources tool">
19b20927172d Uploaded
swebb
parents:
diff changeset
71 <validator type="empty_field" message="Please enter a value"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
72 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
73 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
74 <when value="auto">
19b20927172d Uploaded
swebb
parents:
diff changeset
75 <param format="tabular" name="gtf_annotation" type="data" label="GTF annotation File (pyGetGTFSources output)" help="Tabular file containing unique list of annotations/sources in selected GTF file. Refer to pyGetGTFSources"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
76 <conditional name="scan">
19b20927172d Uploaded
swebb
parents:
diff changeset
77 <param name="annotations" type="select" label="Scan this file for annotations" help="Choose the correct GTF file then choose GO">
19b20927172d Uploaded
swebb
parents:
diff changeset
78 <option value="wait" selected="true">Waiting</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
79 <option value="scanning">Go</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
80 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
81 <when value="wait">
19b20927172d Uploaded
swebb
parents:
diff changeset
82 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
83 <when value="scanning">
19b20927172d Uploaded
swebb
parents:
diff changeset
84 <param name="annotation" type="select" multiple="false" label="Select which annotation to focus search on --annotation">
19b20927172d Uploaded
swebb
parents:
diff changeset
85 <options from_dataset="gtf_annotation">
19b20927172d Uploaded
swebb
parents:
diff changeset
86 <column name="name" index="0"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
87 <column name="value" index="0"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
88 </options>
19b20927172d Uploaded
swebb
parents:
diff changeset
89 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
90 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
91 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
92 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
93 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
94 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
95 <when value="other">
19b20927172d Uploaded
swebb
parents:
diff changeset
96 <param format="gtf" name="gtf" type="data" label="GTF File --gtf" help="GTF file containing gene ID co-ordinates"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
97 <conditional name="annotate">
19b20927172d Uploaded
swebb
parents:
diff changeset
98 <param name="annotations" type="select" label="Select annotation">
19b20927172d Uploaded
swebb
parents:
diff changeset
99 <option value="all" selected="true">All</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
100 <option value="manual">Enter in text box</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
101 <option value="auto">Scan selected file</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
102 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
103 <when value="all">
19b20927172d Uploaded
swebb
parents:
diff changeset
104 <param name="annotation" type="hidden" format="txt" size="10" value="all"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
105 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
106 <when value="manual">
19b20927172d Uploaded
swebb
parents:
diff changeset
107 <param name="annotation" type="text" format="txt" size="100" value="protein_coding" label="Select which annotation to focus search on --annotation" help="To find a list of available annotations please use pyGetGTFSources tool">
19b20927172d Uploaded
swebb
parents:
diff changeset
108 <validator type="empty_field" message="Please enter a value"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
109 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
110 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
111 <when value="auto">
19b20927172d Uploaded
swebb
parents:
diff changeset
112 <param name="annotation" type="select" multiple="false" label="Select which annotation to focus search on --annotation">
19b20927172d Uploaded
swebb
parents:
diff changeset
113 <options from_dataset="gtf">
19b20927172d Uploaded
swebb
parents:
diff changeset
114 <column name="name" index="1"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
115 <column name="value" index="1"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
116 <filter type="unique_value" name="unique" column="1"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
117 </options>
19b20927172d Uploaded
swebb
parents:
diff changeset
118 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
119 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
120 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
121 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
122 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
123 <conditional name="addOpt">
19b20927172d Uploaded
swebb
parents:
diff changeset
124 <param name="options" type="select" label="Standard options">
19b20927172d Uploaded
swebb
parents:
diff changeset
125 <option value="default" selected="true">Default</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
126 <option value="edit">Edit</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
127 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
128 <when value="edit">
19b20927172d Uploaded
swebb
parents:
diff changeset
129 <param format="integer" name="kmin" type="integer" label="Minimum k-mer Length --k_min " value="4" size="6" help="Set the minimal k-mer length">
19b20927172d Uploaded
swebb
parents:
diff changeset
130 <validator type="in_range" min="1" message="Please enter a value >= 1"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
131 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
132 <param format="integer" name="kmax" type="integer" label="Maximum k-mer Length --k_min " value="8" size="6" help="Set the minimal k-mer length">
19b20927172d Uploaded
swebb
parents:
diff changeset
133 <validator type="in_range" min="0" message="Please enter a value >= 0"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
134 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
135 <param format="integer" name="numberofkmers" type="integer" label="Maximum number of k-mers in output file --numberofkmers" value="1000" size="6" help="Set the maximum number of k-mers in output">
19b20927172d Uploaded
swebb
parents:
diff changeset
136 <validator type="in_range" min="0" message="Please enter a value >= 0"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
137 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
138 <param format="integer" name="range" type="integer" label="Range --range" value="0" size="5" help="Manually set the length of the 5' and 3' UTRs 0>50000">
19b20927172d Uploaded
swebb
parents:
diff changeset
139 <validator type="in_range" min="0" max="50000" message="Please enter a value between 0 and 50000"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
140 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
141 <param format="integer" name="overlap" type="integer" label="Overlap --overlap" value="1" size="5" help="Sets the number of nucleotides a read has to overlap with a gene before it is considered a hit. ">
19b20927172d Uploaded
swebb
parents:
diff changeset
142 <validator type="in_range" min="1" message="Please enter a positive integer"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
143 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
144 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
145 <when value="default">
19b20927172d Uploaded
swebb
parents:
diff changeset
146 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
147 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
148 <param name="label" type="text" format="txt" size="30" value="pyMotif" label="Enter output file label -o" />
19b20927172d Uploaded
swebb
parents:
diff changeset
149 </inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
150
19b20927172d Uploaded
swebb
parents:
diff changeset
151 <outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
152 <data format="tabular" name="zscores" label="${label.value}_k-mer_Z_scores.txt"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
153 <data format="tabular" name="count" label="${label.value}_data_k-mers_count.txt"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
154 <data format="gtf" name="features" label="${label.value}_top_k-mers_in_features.gtf"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
155 <data format="tabular" name="random" label="${label.value}_random_k-mers_count.txt"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
156 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
157 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
158
19b20927172d Uploaded
swebb
parents:
diff changeset
159 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
160
19b20927172d Uploaded
swebb
parents:
diff changeset
161 **pyMotif**
19b20927172d Uploaded
swebb
parents:
diff changeset
162
19b20927172d Uploaded
swebb
parents:
diff changeset
163 pyMotif is part of the pyCRAC_ package. Looks for enriched sequence motifs in high-throughput sequencing data. Produces a GTF type output file
19b20927172d Uploaded
swebb
parents:
diff changeset
164 with coordinates and Z-scores for enriched motifs. The GTF file can be visualised in genome browsers.
19b20927172d Uploaded
swebb
parents:
diff changeset
165
19b20927172d Uploaded
swebb
parents:
diff changeset
166 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
167
19b20927172d Uploaded
swebb
parents:
diff changeset
168 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
169
19b20927172d Uploaded
swebb
parents:
diff changeset
170 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
171
19b20927172d Uploaded
swebb
parents:
diff changeset
172 File input options::
19b20927172d Uploaded
swebb
parents:
diff changeset
173
19b20927172d Uploaded
swebb
parents:
diff changeset
174 -f intervals.gtf, --input_file=intervals.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
175 Provide the path to an interval gtf file. By default
19b20927172d Uploaded
swebb
parents:
diff changeset
176 it expects data from the standard input.
19b20927172d Uploaded
swebb
parents:
diff changeset
177 -o OUTPUT_FILE, --output_file=OUTPUT_FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
178 Use this flag to override the standard file names. Do
19b20927172d Uploaded
swebb
parents:
diff changeset
179 NOT add an extension.
19b20927172d Uploaded
swebb
parents:
diff changeset
180 --gtf=annotation_file.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
181 type the path to the gtf annotation file that you want
19b20927172d Uploaded
swebb
parents:
diff changeset
182 to use
19b20927172d Uploaded
swebb
parents:
diff changeset
183 --tab=tab_file.tab
19b20927172d Uploaded
swebb
parents:
diff changeset
184 type the path to the tab file that contains the
19b20927172d Uploaded
swebb
parents:
diff changeset
185 genomic reference sequence
19b20927172d Uploaded
swebb
parents:
diff changeset
186
19b20927172d Uploaded
swebb
parents:
diff changeset
187 pyMotif specific options::
19b20927172d Uploaded
swebb
parents:
diff changeset
188
19b20927172d Uploaded
swebb
parents:
diff changeset
189 --k_min=4
19b20927172d Uploaded
swebb
parents:
diff changeset
190 this option allows you to set the shortest k-mer
19b20927172d Uploaded
swebb
parents:
diff changeset
191 length. Default = 4.
19b20927172d Uploaded
swebb
parents:
diff changeset
192 --k_max=6
19b20927172d Uploaded
swebb
parents:
diff changeset
193 this option allows you to set the longest k-mer
19b20927172d Uploaded
swebb
parents:
diff changeset
194 length. Default = 8.
19b20927172d Uploaded
swebb
parents:
diff changeset
195 -n 100, --numberofkmers=100
19b20927172d Uploaded
swebb
parents:
diff changeset
196 choose the maximum number of enriched k-mer sequences
19b20927172d Uploaded
swebb
parents:
diff changeset
197 you want to have reported in output files. Default =
19b20927172d Uploaded
swebb
parents:
diff changeset
198 1000
19b20927172d Uploaded
swebb
parents:
diff changeset
199
19b20927172d Uploaded
swebb
parents:
diff changeset
200 pyCRAC common options::
19b20927172d Uploaded
swebb
parents:
diff changeset
201
19b20927172d Uploaded
swebb
parents:
diff changeset
202 -a protein_coding, --annotation=protein_coding
19b20927172d Uploaded
swebb
parents:
diff changeset
203 select which annotation (i.e. protein_coding, ncRNA,
19b20927172d Uploaded
swebb
parents:
diff changeset
204 sRNA, rRNA,snoRNA,snRNA, depending on the source of
19b20927172d Uploaded
swebb
parents:
diff changeset
205 your GTF file) you would like to focus your search on.
19b20927172d Uploaded
swebb
parents:
diff changeset
206 Default = all annotations
19b20927172d Uploaded
swebb
parents:
diff changeset
207 -r 100, --range=100
19b20927172d Uploaded
swebb
parents:
diff changeset
208 allows you to add regions flanking the genomic
19b20927172d Uploaded
swebb
parents:
diff changeset
209 feature. If you set '-r 50' or '--range=50', then the
19b20927172d Uploaded
swebb
parents:
diff changeset
210 program will add 50 nucleotides to each feature on
19b20927172d Uploaded
swebb
parents:
diff changeset
211 each side regardless of whether the GTF file has genes
19b20927172d Uploaded
swebb
parents:
diff changeset
212 with annotated UTRs.
19b20927172d Uploaded
swebb
parents:
diff changeset
213 --overlap=1
19b20927172d Uploaded
swebb
parents:
diff changeset
214 sets the number of nucleotides a motif has to overlap
19b20927172d Uploaded
swebb
parents:
diff changeset
215 with a genomic feature before it is considered a hit.
19b20927172d Uploaded
swebb
parents:
diff changeset
216 Default = 1 nucleotide
19b20927172d Uploaded
swebb
parents:
diff changeset
217
19b20927172d Uploaded
swebb
parents:
diff changeset
218
19b20927172d Uploaded
swebb
parents:
diff changeset
219
19b20927172d Uploaded
swebb
parents:
diff changeset
220
19b20927172d Uploaded
swebb
parents:
diff changeset
221 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
222 </tool>