annotate phonR_tool.xml @ 3:24f05f509f09 draft

planemo upload commit e4adec77d8b4e6385b7db85ebbe01cfb85ed8de2
author stevecassidy
date Fri, 14 Oct 2016 15:07:25 -0400
parents 3e7b945648a4
children 0c6aea9fe490
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
1 <tool id="vowel_plot" name="Plot Vowels" version="0.01" force_history_refresh="True">
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
2 <description>Using phonR to produce a Vowel Plot</description>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
3
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
4 <requirements>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
5 <requirement type="package" version="3.2.1">R</requirement>
1
4c17593167f0 planemo upload commit 8787f5af57672a8fd5311e206b872833c8b3fede-dirty
stevecassidy
parents: 0
diff changeset
6 <requirement type="package" version="1.0_3">r-phonr</requirement>
2
3e7b945648a4 planemo upload commit 872df0b3bcaa92f0cac12cd46d4f2fa6de261293-dirty
stevecassidy
parents: 1
diff changeset
7 <requirement type="package">r-getopt</requirement>
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
8 </requirements>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
9
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
10 <command interpreter="Rscript">
3
24f05f509f09 planemo upload commit e4adec77d8b4e6385b7db85ebbe01cfb85ed8de2
stevecassidy
parents: 2
diff changeset
11 $__tool_directory__/phonR_tool.R --input="${input}" --pdffile="$pdffile" --column1="${f1}" --column2="${f2}" --columnvowels="${vowel}" --pretty="${pretty}" --ellipse="${ellipse}" --tokens="${tokens}" --means="${means}" --cextokens="${cextokens}" --alphatokens="${alphatokens}" --cexmeans="${cexmeans}"
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
12 </command>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
13
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
14 <inputs>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
15 <param name="input" type="data" format="tabular" label="Segment List" help=""/>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
16 <param name="f1" type="data_column" data_ref="input" label="Column for f1" force_select="true" use_header_names="true"/>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
17 <param name="f2" type="data_column" data_ref="input" label="Column for f2" force_select="true" use_header_names="true"/>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
18 <param name="vowel" type="data_column" data_ref="input" label="Column with Vowels" force_select="true" use_header_names="true"/>
1
4c17593167f0 planemo upload commit 8787f5af57672a8fd5311e206b872833c8b3fede-dirty
stevecassidy
parents: 0
diff changeset
19 <param name="pretty" type="boolean" label="Make Pretty"
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
20 truevalue="TRUE" falsevalue="FALSE" checked="True"
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
21 help="Will apply various beautification techniques." />
1
4c17593167f0 planemo upload commit 8787f5af57672a8fd5311e206b872833c8b3fede-dirty
stevecassidy
parents: 0
diff changeset
22 <param name="ellipse" type="boolean" label="Add Ellipses"
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
23 truevalue="TRUE" falsevalue="FALSE" checked="True"
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
24 help="Will add an ellipse around the location of each vowel cluster." />
1
4c17593167f0 planemo upload commit 8787f5af57672a8fd5311e206b872833c8b3fede-dirty
stevecassidy
parents: 0
diff changeset
25 <param name="tokens" type="boolean" label="Add Tokens"
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
26 truevalue="TRUE" falsevalue="FALSE" checked="True"
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
27 help="Will add tokens to the plot." />
1
4c17593167f0 planemo upload commit 8787f5af57672a8fd5311e206b872833c8b3fede-dirty
stevecassidy
parents: 0
diff changeset
28 <param name="means" type="boolean" label="Add Means"
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
29 truevalue="TRUE" falsevalue="FALSE" checked="True"
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
30 help="Will add means to the plot." />
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
31 <param name="cextokens" type="float" label="cex.tokens" value="1.2" min="0.0" max="10.0"
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
32 help="Size of tokens on the plot." />
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
33 <param name="alphatokens" type="float" label="alpha.tokens" value="0.2" min="0.0" max="1.0"
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
34 help="The alpha of the tokens on the plot (transparency). NOTE: Must be a value betweek 0 and 1!" />
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
35 <param name="cexmeans" type="float" label="cex.means" value="2" min="0.0" max="10.0"
1
4c17593167f0 planemo upload commit 8787f5af57672a8fd5311e206b872833c8b3fede-dirty
stevecassidy
parents: 0
diff changeset
36 help="Size of the means on the plot." />
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
37 </inputs>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
38
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
39 <outputs>
3
24f05f509f09 planemo upload commit e4adec77d8b4e6385b7db85ebbe01cfb85ed8de2
stevecassidy
parents: 2
diff changeset
40 <data format="pdf" name="pdffile" label="vowelplot.pdf" />
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
41 </outputs>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
42
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
43
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
44 <tests>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
45 <test>
1
4c17593167f0 planemo upload commit 8787f5af57672a8fd5311e206b872833c8b3fede-dirty
stevecassidy
parents: 0
diff changeset
46 <param name="input" value="femaletest.tsv"/>
2
3e7b945648a4 planemo upload commit 872df0b3bcaa92f0cac12cd46d4f2fa6de261293-dirty
stevecassidy
parents: 1
diff changeset
47 <param name="f1" value='4' />
3e7b945648a4 planemo upload commit 872df0b3bcaa92f0cac12cd46d4f2fa6de261293-dirty
stevecassidy
parents: 1
diff changeset
48 <param name="f2" value='5' />
3
24f05f509f09 planemo upload commit e4adec77d8b4e6385b7db85ebbe01cfb85ed8de2
stevecassidy
parents: 2
diff changeset
49 <param name="vowel" value='3'/>
24f05f509f09 planemo upload commit e4adec77d8b4e6385b7db85ebbe01cfb85ed8de2
stevecassidy
parents: 2
diff changeset
50 <output name="output" file="femalevowelplot.pdf" compare="sim_size" />
0
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
51 </test>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
52 </tests>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
53
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
54 <help>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
55 Will make a vowel plot from given data. Best used from data directly run from the "Get Formants at segment midpoint" Tool.
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
56 </help>
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
57
3d068b7441be planemo upload commit f36456464c692ed9d39a9cf654d09fe793113cce-dirty
stevecassidy
parents:
diff changeset
58 </tool>