annotate meme_psp_gen.xml @ 2:c32084cb7fe7 draft

Uploaded
author greg
date Thu, 17 Aug 2017 09:56:31 -0400
parents e7b8db2b9246
children 79df81990900
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
1 <tool id="meme_psp_gen" name="MEME psp-gen" version="4.11.2.0">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
2 <description>- perform discriminative motif discovery</description>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
3 <macros>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
4 <import>macros.xml</import>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
5 </macros>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
6 <expand macro="requirements" />
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
8 psp-gen
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
9 -pos '$primary_sequence'
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
10 -neg '$control_sequence'
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
11 -minw $adv.minw
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
12 -maxw $adv.maxw
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
13 $adv.alphabet
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
14 #if str($adv.triples_cond.triples) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
15 -triples
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
16 #if str($adv.triples_cond.fixed_start) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
17 -fixedstart
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
18 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
19 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
20 #if str($adv.equiv) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
21 -equiv
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
22 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
23 #if str($adv.consider_both_strands) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
24 -revcomp
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
25 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
26 #if str($adv.scale_min) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
27 -scalemin
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
28 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
29 #if str($adv.scale_max) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
30 -scalemax
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
31 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
32 #if str($adv.max_range) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
33 -maxrange
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
34 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
35 #if str($adv.raw) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
36 -raw
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
37 #end if
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
38 #if str($adv.report_scores_cond.report_scores) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
39 -reportscores
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
40 #if str($adv.report_scores_cond.verbose) == 'yes':
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
41 -verbose
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
42 #end if
2
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
43 2> '$output_tabular'
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
44 #end if
2
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
45 > '$output_psp'
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
46 ]]></command>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
47 <inputs>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
48 <param format="fasta" name="primary_sequence" type="data" label="Primary sequence file"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
49 <param format="fasta" name="control_sequence" type="data" label="Control sequence file"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
50 <section name="adv" title="Additional Options">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
51 <param name="minw" type="integer" value="4" min="0" label="Minimum width to use for position specific priors"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
52 <param name="maxw" type="integer" value="20" min="0" label="Maximum width to use for position specific priors"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
53 <param name="alphabet" type="select" label="Alphabet">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
54 <option value="-dna" selected="true">DNA</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
55 <option value="-protein">protein</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
56 <option value="-rna">RNA</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
57 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
58 <conditional name="triples_cond">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
59 <param name="triples" type="select" label="Use spaced triples instead of whole-word matches?" help="Recommended for protein">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
60 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
61 <option value="yes">yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
62 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
63 <when value="no"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
64 <when value="yes">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
65 <param name="fixed_start" type="select" display="radio" label="Allow triples to start anywhere within a site?" help="Select 'No' to only consider triples starting at the start of the site">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
66 <option value="yes" selected="true">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
67 <option value="no">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
68 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
69 </when>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
70 </conditional>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
71 <param name="equiv" type="select" display="radio" label="Match as equal sequences of letters that appear together?">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
72 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
73 <option value="yes">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
74 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
75 <param name="consider_both_strands" type="select" display="radio" label="Consider both strands when calculating position specific priors for alphabets?">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
76 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
77 <option value="yes">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
78 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
79 <param name="scale_min" type="select" display="radio" label="Set the lowest score value after scaling?">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
80 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
81 <option value="yes">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
82 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
83 <param name="scale_max" type="select" display="radio" label="Set the highest score value after scaling?">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
84 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
85 <option value="yes">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
86 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
87 <param name="max_range" type="select" display="radio" label="Choose the width with the biggest difference between minimum and maximum scores before scaling?" help="Select 'No' to choose the width with the biggest maximum score (before scaling)">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
88 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
89 <option value="yes">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
90 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
91 <param name="raw" type="select" display="radio" label="Output scores instead of priors?">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
92 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
93 <option value="yes">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
94 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
95 <conditional name="report_scores_cond">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
96 <param name="report_scores" type="select" label="Output primary and control file names, scores and widths?">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
97 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
98 <option value="yes">yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
99 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
100 <when value="no"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
101 <when value="yes">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
102 <param name="verbose" type="select" display="radio" label="Report frequency of each score?">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
103 <option value="no" selected="true">No</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
104 <option value="yes">Yes</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
105 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
106 </when>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
107 </conditional>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
108 </section>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
109 <param name="non_commercial_use" label="I certify that I am not using this tool for commercial purposes." type="boolean" truevalue="NON_COMMERCIAL_USE" falsevalue="COMMERCIAL_USE" checked="False">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
110 <validator type="expression" message="This tool is only available for non-commercial use.">value == True</validator>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
111 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
112 </inputs>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
113 <outputs>
2
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
114 <data format="memepsp" name="output_psp"/>
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
115 <data format="tabular" name="output_tabular" label="${tool.name} (report) on ${on_string}">
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
116 <filter>adv['report_scores_cond'] == 'yes'</filter>
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
117 </data>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
118 </outputs>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
119 <tests>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
120 <test>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
121 <param name="input1" value="meme_input_1.fasta" ftype="fasta" dbkey="hg19"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
122 <param name="options_type_selector" value="basic"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
123 <param name="non_commercial_use" value="True"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
124 <output name="html_outfile" file="meme_output_html_1.html" compare="contains"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
125 <output name="txt_outfile" file="meme_output_txt_1.txt" lines_diff="12"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
126 <output name="xml_outfile" file="meme_output_xml_1.xml" lines_diff="8"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
127 </test>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
128 </tests>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
129 <help>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
130
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
131 .. class:: warningmark
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
132
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
133 **WARNING: This tool is only available for non-commercial use. Use for educational, research and non-profit purposes is permitted.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
134 Before using, be sure to review, agree, and comply with the license.**
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
135
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
136 psp-gen is used to allow MEME to perform discriminative motif discovery—to find motifs overrepresented in one set of sequences compared to in another set.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
137 It takes two files as input—the sequence file to be input to MEME, (the "primary" file) and a "control" sequence file of sequences believed not to contain
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
138 the same motifs as in the "primary" file. psp-gen creates a file for use by MEME that encapsulates information about probable discriminative motifs. psp-gen
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
139 records its chosen motif width in the file, and MEME is able to adjust the data when it tries different motif widths.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
140
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
141 .. class:: infomark
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
142
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
143 For detailed information on psp-gen, click here_, or view the license_.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
144
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
145 .. _here: http://meme-suite.org/doc/psp-gen.html?man_type=web
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
146 .. _license: http://meme-suite.org/doc/copyright.html?man_type=web
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
147
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
148 -----
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
149
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
150 **Required options**
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
151
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
152 * **Primary sequence file** - a file containing FASTA formatted sequences which are to be used as the primary set in PSP calculation.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
153 * **Control sequence file** - a file containing FASTA formatted sequences which are to be used as the control set in PSP calculation.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
154
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
155 **Advanced options**
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
156
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
157 * **Minimum width to use for position specific priors** - the minimum width to use with selecting the "best" width for PSPs.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
158 * **Maximum width to use for position specific priors** - the maximum width to use with selecting the "best" width for PSPs.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
159 * **Alphabet** - The alphabet to be used, one of DNA, protein or RNA.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
160 * **Use spaced triples instead of whole-word matches** - use spaced triples instead of whole-word matches (recommended when using the protein alphabet).
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
161
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
162 * **Allow triples to start anywhere within a site** - when using the -triples option, select 'Yes' to only consider triples starting at the start of the site or 'No' to allow triples to start anywhere in a width 'w' site.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
163
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
164 * **Match as equal sequences of letters that appear together** - select 'Yes' to match as equal any sequence of letter that appears together. Separate letter groups using "-" (e.g. -equiv "IVL-HKR") means treat all occurrences of I, V or L as the same, and all occurrences of H, K or R as the same.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
165 * **Consider both strands when calculating position specific priors for alphabets** - select 'Yes' to consider both strands when calculating PSPs for complementable alphabets or 'No to consider only the given strand.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
166 * **Set the lowest score value after scaling** - select 'Yes' to set the lowest score to 0.1 unless the the following "highest score" option is selected, in which case the lowest score is highest score - 1.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
167 * **Set the highest score value after scaling** - select 'Yes' to set the highest score to 0.9 unless the previous "lowest score" option is selected, in which case the highest score is lowest score + 1.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
168 * **Choose the width with the biggest difference between minimum and maximum scores before scaling** - select 'Yes' to choose the width with the biggest difference between minimum and maximum scores before scaling, or 'No' to choose the width with the biggest maximum score before scaling.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
169 * **Output scores instead of priors** - select 'Yes' to output scores instead of position specific priors.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
170 * **Output primary and control file names, scores and widths** - select 'Yes' to produce an additional tabular output consisting of control file names, lowest and highest scores and lowest and highest widths.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
171
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
172 * **Report frequency of each score** - select 'Yes' to include the frequency of each score in the output.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
173
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
174 </help>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
175 <citations>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
176 <citation type="bibtex">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
177 @article{Bailey2010,
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
178 journal = {BMC Bioinformatics}
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
179 author = {Bailey Timothy L, Bodén Mikael, Whitington Tom, Machanick Philip},
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
180 title = {The value of position-specific priors in motif discovery using MEME},
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
181 year = {2010},
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
182 volume = {11},
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
183 number = {1},
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
184 pages = {179}
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
185 }</citation>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
186 </citations>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
187 </tool>