annotate isoplot.xml @ 1:f333e9b5f1c1 draft default tip

test data initial upload
author llegregam
date Mon, 28 Jun 2021 11:50:06 +0000
parents 918940a0944c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
1 <tool id='isoplot' name='Isoplot: Generate plots from isocor output' version='0.1.0'>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
2 <requirements>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
3 <requirement type='package' version='1.3.0'>isoplot</requirement>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
4 </requirements>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
5 <command><![CDATA[
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
6 isoplot '$datafile' 'galaxy' '$format' --value '$value' --template '$template_file'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
7 #if $SP.generate_barplot:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
8 -bp
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
9 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
10 #if $SP.generate_meanplot:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
11 -mb
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
12 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
13 #if $SP.generate_heatmap:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
14 -hm
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
15 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
16 #if $SP.generate_clustermap:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
17 -cm
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
18 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
19 #if $IP.generate_barplot:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
20 -IB
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
21 #end i
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
22 #if $IP.generate_meanplot:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
23 -IM
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
24 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
25 #if $IP.generate_heatmap:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
26 -HM
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
27 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
28 #if $stack:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
29 -s
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
30 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
31 #if $verbosity:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
32 -v
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
33 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
34 #if $annotation:
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
35 -a
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
36 #end if
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
37 -g -z '$output2' > $output1 2> '$output3'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
38 ]]></command>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
39 <inputs>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
40 <param name='datafile' type='data' format='csv, tsv' multiple='true' label='Upload data file' />
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
41 <param name='template_file' type='data' format='csv, xlsx' multiple='true' label='Template file' argument='--template'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
42 <!--param name='run_name' type='text' label='Run name' /-->
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
43 <param name='format' type='select' label='Plot format'>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
44 <option value='pdf'>pdf</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
45 <option value='jpeg'>jpeg</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
46 <option value='png'>png</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
47 <option value='svg'>svg</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
48 <option value='html'>html</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
49 </param>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
50 <param name='value' type='select' label='Data to plot' >
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
51 <option value='corrected_area'>Corrected Area</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
52 <option value='isotopologue_fraction'>Isotopologue Fraction</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
53 <option value='mean_enrichment'>Mean Enrichment</option>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
54 </param>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
55 <section name='SP' title='Select static plots to generate'>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
56 <param type='boolean' name='generate_barplot' label='Flag to generate barplots' argument='-bp'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
57 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
58 <param type='boolean' name='generate_meanplot' label='Flag to generate meaned barplots' argument='-mb'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
59 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
60 <!--<param type='boolean' name='generate_areaplot' label='Flag to generate stacked area plots'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
61 argument='-sa' optional='true'/>/-->
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
62 <param type='boolean' name='generate_heatmap' label='Flag to generate heatmap' argument='-hm'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
63 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
64 <param type='boolean' name='generate_clustermap' label='Flag to generate clustermap' argument='-cm'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
65 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
66 </section>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
67 <section name='IP' title='Select interactive plots to generate'>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
68 <param type='boolean' name='generate_barplot' label='Flag to generate barplots' argument='-IB'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
69 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
70 <param type='boolean' name='generate_meanplot' label='Flag to generate meaned barplots' argument='-IM'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
71 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
72 <!-- <param type='boolean' name='generate_areaplot' label='Flag to generate stacked area plots' argument='-IS'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
73 optional='true'/>-->
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
74 <param type='boolean' name='generate_heatmap' label='Flag to generate heatmap' argument='-HM'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
75 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
76 </section>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
77 <param type='boolean' name='stack' label='Flag to unstack bars in barplots' argument='-s' optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
78 <param type='boolean' name='verbosity' label='Flag to get debug information' argument='-v' optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
79 <param type='boolean' name='annotation' label='Flag to add annotations on the maps' argument='-a'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
80 optional='true'/>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
81 </inputs>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
82 <outputs>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
83 <data name='output1' format='csv' label='Formatted data used for plotting' />
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
84 <data name='output2' format='zip' label='Resulting plots' />
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
85 <data name='output3' format='txt' label='Run Info' />
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
86 </outputs>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
87 <help><![CDATA[
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
88
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
89 Isoplot2: Plotting isotopic labelling MS data
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
90 =============================================
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
91
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
92 **Positional arguments:**
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
93
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
94 input_path Path to datafile
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
95 run_name Name of the current run
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
96 format Format of generated file
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
97
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
98 **optional arguments:**
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
99 -h, --help show this help message and exit
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
100 --value Choices: "corrected_area", "isotopologue_fraction", "mean_enrichment". Select values to plot. This option can be given multiple times
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
101
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
102 -m METABOLITE Metabolite(s) to plot. For all, type in 'all'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
103 -c CONDITION Condition(s) to plot. For all, type in 'all'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
104 -t TIME Time(s) to plot. For all, type in 'all'
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
105 -tp TEMPLATE_PATH Path to template file
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
106
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
107 -sa, --stacked_areaplot Create static stacked areaplot
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
108 -bp, --barplot Create static barplot
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
109 -mb, --meaned_barplot Create static barplot with meaned replicates
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
110
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
111 -IB, --interactive_barplot Create interactive stacked barplot
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
112 -IM, --interactive_stacked_meanplot Create interactive stacked barplot with meaned replicates
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
113 -IS, --interactive_areaplot Create interactive stacked areaplot
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
114 -hm, --static_heatmap Create a static heatmap using mean enrichment data
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
115 -cm, --static_clustermap Create a static heatmap with clustering using mean enrichment data
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
116 -HM, --interactive_heatmap Create interactive heatmap using mean enrichment data
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
117
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
118 -s, --stack Add option if barplots should be unstacked
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
119 -v, --verbose Turns logger to debug mode
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
120 -a, --annot Add option if annotations should be added on maps
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
121
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
122 ]]></help>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
123 <citations>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
124 <citation type='bibtex'>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
125 @misc{githubisoplot,
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
126 author = {Le Gregam, Loic},
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
127 year = {2021},
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
128 title = {isoplot},
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
129 publisher = {GitHub},
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
130 journal = {GitHub repository},
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
131 url = {https://github.com/llegregam},
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
132 }</citation>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
133 </citations>
918940a0944c initial upload of isoplot.xml
llegregam
parents:
diff changeset
134 </tool>