annotate meme_psp_gen.xml @ 4:01d22cb1bccc draft

Uploaded
author greg
date Mon, 21 Aug 2017 08:16:59 -0400
parents 79df81990900
children e994f439190c
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
4
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
14 #if $adv.report_scores_cond.report_scores:
2
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
15 2> '$output_tabular'
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
16 #end if
2
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
17 > '$output_psp'
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
18 ]]></command>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
19 <inputs>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
20 <param format="fasta" name="primary_sequence" type="data" label="Primary sequence file"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
21 <param format="fasta" name="control_sequence" type="data" label="Control sequence file"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
22 <section name="adv" title="Additional Options">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
23 <param name="minw" type="integer" value="4" min="0" label="Minimum width to use for position specific priors"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
24 <param name="maxw" type="integer" value="20" min="0" label="Maximum width to use for position specific priors"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
25 <param name="alphabet" type="select" label="Alphabet">
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
26 <option value="-dna" selected="true">DNA</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
27 <option value="-protein">protein</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
28 <option value="-rna">RNA</option>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
29 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
30 <conditional name="triples_cond">
4
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
31 <param name="triples" type="boolean" truevalue="-triples" falsevalue="" checked="False" label="Use spaced triples instead of whole-word matches?" help="Recommended for protein"/>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
32 <when value="no"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
33 <when value="yes">
4
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
34 <param name="fixed_start" type="boolean" truevalue="-fixedstart" falsevalue="" checked="False" label="Allow triples to start anywhere within a site?" help="Select 'No' to only consider triples starting at the start of the site"/>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
35 </when>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
36 </conditional>
4
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
37 <param name="equiv" type="boolean" truevalue="-equiv" falsevalue="" checked="False" label="Match as equal sequences of letters that appear together?"/>
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
38 <param name="consider_both_strands" type="boolean" truevalue="-revcomp" falsevalue="" checked="False" label="Consider both strands when calculating position specific priors for alphabets?"/>
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
39 <param name="scale_min" type="boolean" truevalue="-scalemin" falsevalue="" checked="False" label="Set the lowest score value after scaling?"/>
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
40 <param name="scale_max" type="boolean" truevalue="-scalemax" falsevalue="" checked="False" label="Set the highest score value after scaling?"/>
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
41 <param name="max_range" type="boolean" truevalue="-maxrange" falsevalue="" checked="False" 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)"/>
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
42 <param name="raw" type="boolean" truevalue="-raw" falsevalue="" checked="False" label="Output scores instead of priors?"/>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
43 <conditional name="report_scores_cond">
4
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
44 <param name="report_scores" type="boolean" truevalue="-reportscores" falsevalue="" checked="False" label="Output primary and control file names, scores and widths?"/>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
45 <when value="no"/>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
46 <when value="yes">
4
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
47 <param name="verbose" type="boolean" truevalue="-verbose" falsevalue="" checked="False" label="Report frequency of each score?"/>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
48 </when>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
49 </conditional>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
50 </section>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
51 <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
52 <validator type="expression" message="This tool is only available for non-commercial use.">value == True</validator>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
53 </param>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
54 </inputs>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
55 <outputs>
2
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
56 <data format="memepsp" name="output_psp"/>
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
57 <data format="tabular" name="output_tabular" label="${tool.name} (report) on ${on_string}">
3
79df81990900 Uploaded
greg
parents: 2
diff changeset
58 <filter>adv['report_scores_cond']['report_scores'] == 'yes'</filter>
2
c32084cb7fe7 Uploaded
greg
parents: 0
diff changeset
59 </data>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
60 </outputs>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
61 <tests>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
62 <test>
3
79df81990900 Uploaded
greg
parents: 2
diff changeset
63 <param name="primary_sequence" value="meme_psp_protein_input.fasta" ftype="fasta"/>
79df81990900 Uploaded
greg
parents: 2
diff changeset
64 <param name="control_sequence" value="meme_psp_protein_input.fasta" ftype="fasta"/>
79df81990900 Uploaded
greg
parents: 2
diff changeset
65 <param name="alphabet" value="protein"/>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
66 <param name="non_commercial_use" value="True"/>
3
79df81990900 Uploaded
greg
parents: 2
diff changeset
67 <output name="output_psp" file="output.memepsp"/>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
68 </test>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
69 </tests>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
70 <help>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
71
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
72 .. class:: warningmark
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
73
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
74 **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
75 Before using, be sure to review, agree, and comply with the license.**
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
76
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
77 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
78 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
79 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
80 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
81
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
82 .. class:: infomark
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
83
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
84 For detailed information on psp-gen, click here_, or view the license_.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
85
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
86 .. _here: http://meme-suite.org/doc/psp-gen.html?man_type=web
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
87 .. _license: http://meme-suite.org/doc/copyright.html?man_type=web
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
88
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
89 -----
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
90
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
91 **Required options**
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
92
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
93 * **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
94 * **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
95
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
96 **Advanced options**
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
97
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
98 * **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
99 * **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
100 * **Alphabet** - The alphabet to be used, one of DNA, protein or RNA.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
101 * **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
102
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
103 * **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
104
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
105 * **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
106 * **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
107 * **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
108 * **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
109 * **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
110 * **Output scores instead of priors** - select 'Yes' to output scores instead of position specific priors.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
111 * **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
112
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
113 * **Report frequency of each score** - select 'Yes' to include the frequency of each score in the output.
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
114
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
115 </help>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
116 <citations>
4
01d22cb1bccc Uploaded
greg
parents: 3
diff changeset
117 <citation type="doi">10.1186/1471-2105-11-179</citation>
0
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
118 </citations>
e7b8db2b9246 Uploaded
greg
parents:
diff changeset
119 </tool>