annotate iReport.xml @ 2:3c160414da2e default tip

initial upload
author shiltemann
date Thu, 26 Feb 2015 14:05:23 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
3c160414da2e initial upload
shiltemann
parents:
diff changeset
1 <tool id="iReport" name="iReport" version="1">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
2
3c160414da2e initial upload
shiltemann
parents:
diff changeset
3 <!-- Note to Galaxy Admins:
3c160414da2e initial upload
shiltemann
parents:
diff changeset
4 This wrapper contains one hidden parameter with hardcoded server location, this is currently needed for dalliance genome browser to function correctly,
3c160414da2e initial upload
shiltemann
parents:
diff changeset
5 please change this value as needed! (see below for parameter: <param name="localhost" type="hidden" value="https://bioninf-galaxian.erasmusmc.nl"/>)
3c160414da2e initial upload
shiltemann
parents:
diff changeset
6 -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
7
3c160414da2e initial upload
shiltemann
parents:
diff changeset
8
3c160414da2e initial upload
shiltemann
parents:
diff changeset
9 <description> create an HTML report </description>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
10
3c160414da2e initial upload
shiltemann
parents:
diff changeset
11 <requirements>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
12 <requirement type="set_environment">REPOSITORY_PATH</requirement>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
13 </requirements>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
14 <command interpreter="bash">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
15 iReport.sh
3c160414da2e initial upload
shiltemann
parents:
diff changeset
16 --toolpath \$REPOSITORY_PATH
3c160414da2e initial upload
shiltemann
parents:
diff changeset
17 --galaxypath ${report.files_path}
3c160414da2e initial upload
shiltemann
parents:
diff changeset
18 --htmlout ${report}
3c160414da2e initial upload
shiltemann
parents:
diff changeset
19 --minwidth ${minwidth}
3c160414da2e initial upload
shiltemann
parents:
diff changeset
20 --coverimage "-${coverimage}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
21 #for $i, $t in enumerate($tabs)
3c160414da2e initial upload
shiltemann
parents:
diff changeset
22 --tab ${t.tabtitle}
3c160414da2e initial upload
shiltemann
parents:
diff changeset
23 #for $j, $u in enumerate($t.content)
3c160414da2e initial upload
shiltemann
parents:
diff changeset
24 #if $u.filetype.itemtype == "image"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
25 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.zoomlevel}:${u.filetype.zoomenable}:${u.filetype.align}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
26 #else if $u.filetype.itemtype == "table"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
27 #if $u.filetype.collink.columnhyperlink == "Y"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
28 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.fancy}:Y:${u.filetype.collink.urlcol}:${u.filetype.collink.urlprefix}:${u.filetype.collink.urlsuffix}:${u.filetype.collink.urlitems}:${u.filetype.minw}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
29 #else
3c160414da2e initial upload
shiltemann
parents:
diff changeset
30 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.fancy}:N:${u.filetype.minw}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
31 #end if
3c160414da2e initial upload
shiltemann
parents:
diff changeset
32 #else if $u.filetype.itemtype == "link"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
33 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${__app__.security.encode_id($u.filetype.item.id)}:${u.filetype.ireport}:${u.filetype.item2}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
34 #else if $u.filetype.itemtype == "weblink"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
35 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.item2}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
36 #else if $u.filetype.itemtype == "text"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
37 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.md}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
38 #else if $u.filetype.itemtype == "textfile"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
39 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.md}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
40 #else if $u.filetype.itemtype == "htmlfile"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
41 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.height}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
42 #else if $u.filetype.itemtype == "htmlpage"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
43 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}:${u.filetype.height}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
44 #else if $u.filetype.itemtype == "genomebrowser"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
45 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.genomebuild}:${u.filetype.break}:${__app__.security.encode_id($report.id)}:${u.filetype.localhost}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
46 --newgb "-"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
47 #for $k, $gb in enumerate($u.filetype.gbtracks)
3c160414da2e initial upload
shiltemann
parents:
diff changeset
48 --genomebrowsertrack ${gb.item}:${gb.tracklabel}:${gb.gbfiletype}
3c160414da2e initial upload
shiltemann
parents:
diff changeset
49 #end for
3c160414da2e initial upload
shiltemann
parents:
diff changeset
50 #else
3c160414da2e initial upload
shiltemann
parents:
diff changeset
51 --item "${t.tabtitle}:${u.filetype.itemtype}:${u.filetype.item}:${u.filetype.break}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
52 #end if
3c160414da2e initial upload
shiltemann
parents:
diff changeset
53 #end for
3c160414da2e initial upload
shiltemann
parents:
diff changeset
54 #end for
3c160414da2e initial upload
shiltemann
parents:
diff changeset
55 --label "${label}"
3c160414da2e initial upload
shiltemann
parents:
diff changeset
56
3c160414da2e initial upload
shiltemann
parents:
diff changeset
57 </command>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
58
3c160414da2e initial upload
shiltemann
parents:
diff changeset
59 <inputs>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
60 <param name="label" type="text" size="100" label="Name of Report" >
3c160414da2e initial upload
shiltemann
parents:
diff changeset
61 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
62 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
63 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
64 <remove value="&quot;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
65 <remove value="\"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
66 <remove value="&#xA;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
67 <remove value="&#xD;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
68 <remove value="&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
69 <remove value=":"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
70 <!--<remove value=" "/>-->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
71 <remove value="`"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
72 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
73 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
74 <add source="\" target="\\"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
75 <add source="&quot;" target="==quote=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
76 <add source="&amp;" target="&amp;&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
77 <add source="&#xA;" target="&amp;n"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
78 <add source="&#xD;" target="&amp;r"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
79 <add source=":" target="==colon=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
80 <!--<add source=" " target="_s_"/>-->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
81 <add source="`" target="==backtick=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
82 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
83 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
84 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
85 <param name="coverimage" type="text" size="100" label="Link to cover image" help="Optional. A default image will be used if not specified"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
86 <param name="minwidth" type="integer" min="0" max="5000" value="1200" label="Width of page (in pixels)" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
87 <repeat name="tabs" title="Tab" default="1" >
3c160414da2e initial upload
shiltemann
parents:
diff changeset
88 <param name="tabtitle" type="text" size="50" label="Enter tab name">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
89 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
90 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
91 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
92 <remove value="&quot;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
93 <remove value="\"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
94 <remove value="&#xA;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
95 <remove value="&#xD;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
96 <remove value="&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
97 <remove value=":"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
98 <remove value=" "/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
99 <remove value="`"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
100 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
101 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
102 <add source="\" target="\\"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
103 <add source="&quot;" target="==quote=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
104 <add source="&amp;" target="&amp;&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
105 <add source="&#xA;" target="&amp;n"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
106 <add source="&#xD;" target="&amp;r"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
107 <add source=":" target="==colon=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
108 <add source=" " target="_s_"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
109 <add source="`" target="==backtick=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
110 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
111 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
112 <validator type="empty_field" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
113 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
114 <repeat name="content" title="Content-Item" default="1">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
115 <conditional name="filetype">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
116 <param name="itemtype" type="select" label="Select Item Type" >
3c160414da2e initial upload
shiltemann
parents:
diff changeset
117 <option value="" > Please choose item type </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
118 <option value="text" > Text Field </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
119 <option value="textfile" > Text File from history </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
120 <option value="htmlfile"> HTML File from history </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
121 <option value="htmlpage"> iFrame with HTML page from web </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
122 <option value="image"> Image </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
123 <option value="pdf" > PDF File </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
124 <option value="table"> Table </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
125 <option value="link" > Link to Dataset </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
126 <option value="links"> Links to Files in Archive Dataset </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
127 <option value="weblink" > Web link </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
128 <option value="genomebrowser" > Genome Browser (unimplemented) </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
129 <validator type="empty_field" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
130 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
131
3c160414da2e initial upload
shiltemann
parents:
diff changeset
132 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
133 # Text Field #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
134 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
135 <when value="text">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
136 <param name="md" type="boolean" truevalue="Y" falsevalue="n" checked="false" label="Text in MarkDown format?" help="If checked, text file or field will be interpreted as markdown"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
137 <param name="item" type="text" area="true" size="10x100" label="Text to display." help="can explicitly add whitespace adding \n in your text for a newline or \t for a tab. HTML tags em, strong, b, i, h1-h6 tags" >
3c160414da2e initial upload
shiltemann
parents:
diff changeset
138 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
139 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
140 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
141 <remove value="\"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
142 <remove value="/"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
143 <remove value=","/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
144 <remove value=":"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
145 <remove value="&lt;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
146 <remove value="&gt;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
147 <remove value="&apos;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
148 <remove value="&quot;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
149 <remove value="&#xA;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
150 <remove value="&#xD;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
151 <remove value="&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
152 <remove value="&#x3a;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
153 <remove value=" "/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
154 <remove value="`"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
155 <remove value="$"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
156 <remove value="|"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
157 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
158 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
159 <add source="\" target="\\"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
160 <add source="/" target="==slash=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
161 <add source="&amp;" target="&amp;&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
162 <add source="&#xA;" target="&amp;n"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
163 <add source="&#xD;" target="&amp;r"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
164 <add source="&#x3a;" target="&amp;c"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
165 <add source=" " target="==space=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
166 <add source="," target="==comma=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
167 <add source="&lt;" target="==lt=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
168 <add source="&gt;" target="==gt=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
169 <add source="&apos;" target="==apos=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
170 <add source="&quot;" target="==quote=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
171 <add source=":" target="==colon=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
172 <add source="`" target="==backtick=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
173 <add source="$" target="==dollar=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
174 <add source="|" target="==bar=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
175 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
176 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
177 <validator type="empty_field" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
178 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
179 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
180 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
181
3c160414da2e initial upload
shiltemann
parents:
diff changeset
182 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
183 # Text File #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
184 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
185 <when value="textfile">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
186 <param name="md" type="boolean" truevalue="Y" falsevalue="n" checked="false" label="Text in MarkDown format?" help="If checked, text file or field will be interpreted as markdown. Will use pandoc if this is installed on the system, else uses a custom script"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
187 <param name="item" type="data" label="Text File" help="Text file to display verbatim"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
188 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
189 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
190
3c160414da2e initial upload
shiltemann
parents:
diff changeset
191 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
192 # HTML File #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
193 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
194 <when value="htmlfile">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
195 <param name="item" type="data" label="HTML File" help="Contents of html file will be displayed in an iframe"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
196 <param name="height" type="integer" min="0" max="500000" value="350" label="Height (in pixels)" help="Height of the iFrame displaying the html page"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
197 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
198 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
199
3c160414da2e initial upload
shiltemann
parents:
diff changeset
200 <when value="htmlpage">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
201 <param name="item" type="text" label="URL" size="100" help="Contents of webpage will be displayed in an iframe">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
202 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
203 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
204 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
205 <remove value="&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
206 <remove value=":"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
207 <remove value="/"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
208 <remove value=" "/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
209 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
210 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
211 <add source="&amp;" target="==amp=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
212 <add source=":" target="==colon=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
213 <add source="/" target="==fslash=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
214 <add source=" " target=""/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
215 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
216 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
217 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
218 <param name="height" type="integer" min="0" max="500000" value="350" label="Height (in pixels)" help="Height of the iFrame displaying the html page"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
219 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
220 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
221
3c160414da2e initial upload
shiltemann
parents:
diff changeset
222 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
223 # Images #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
224 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
225 <when value="image">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
226 <param name="item" type="data" label="Image File" format="png,svg,jpg,jpeg" help="Supported formats: png, jpg, svg. If image is scaled by choice of width, zoom-on-mousover effect is added."/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
227 <param name="zoomlevel" type="integer" min="0" max="5000" value="250" label="Width (in pixels)" help="enter 0 to keep original size" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
228 <param name="zoomenable" type="boolean" checked="True" truevalue="Y" falsevalue="N" label="Enable zoom-on-mouseover effect?" help="If checked and nonzero width, zoom-on-mousover effect added"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
229 <param name="align" type="select" label="Alignment of image (float)" help="Use left or right align to have images and text next to each other. Always specify image first (with alignment), then text, if you want to show them side by side." >
3c160414da2e initial upload
shiltemann
parents:
diff changeset
230 <option value="none" > default (recommended) </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
231 <option value="left" > left </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
232 <option value="right" > right </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
233 <option value="middle"> center </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
234 <!--<option value="top"> top </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
235 <option value="bottom"> bottom </option>-->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
236 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
237 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
238 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
239
3c160414da2e initial upload
shiltemann
parents:
diff changeset
240 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
241 # Table #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
242 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
243 <when value="table">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
244 <param name="item" type="data" label="Table File" help="must be a tab-delimited file with a 1-line header" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
245 <param name="fancy" type="boolean" checked="True" truevalue="Y" falsevalue="N" label="Fancy table)?" help="If selected, will create, sortable, searchable, paginated table. Otherwise not (for small tables)"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
246 <param name="minw" type="integer" value="0" label="Minimum width of table (in pixels)" help="only needed when tables are not displaying correctly"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
247 <conditional name="collink">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
248 <param name="columnhyperlink" type="select" label="create url links from one of the columns in your table?" help="For example: from column with gene names, link to genecards page">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
249 <option value="N"> No </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
250 <option value="Y"> Yes </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
251 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
252 <when value="Y">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
253 <param name="urlcol" type="data_column" data_ref="item" multiple="False" label="Column to turn in to weblinks" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
254 <param name="urlprefix" type="text" size="75" label="URL prefix" help="this will be placed before value in column to form the weblink. e.g. for genecards use: http://www.genecards.org/cgi-bin/carddisp.pl?gene=">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
255 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
256 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
257 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
258 <remove value="&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
259 <remove value=":"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
260 <remove value="/"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
261 <remove value=" "/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
262 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
263 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
264 <add source="&amp;" target="==amp=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
265 <add source=":" target="==colon=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
266 <add source="/" target="//"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
267 <add source=" " target=""/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
268 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
269 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
270 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
271 <param name="urlsuffix" type="text" size="75" label="URL suffix" help="this will be placed before value in column to form the weblink. e.g. For genecards, there is no suffix">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
272 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
273 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
274 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
275 <remove value="&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
276 <remove value="/"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
277 <remove value=" "/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
278 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
279 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
280 <add source="&amp;" target="&amp;&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
281 <add source="/" target="//"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
282 <add source=" " target=""/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
283 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
284 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
285 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
286 <param name="urlitems" type="data" label="(Not yet implemented) Archive with files to link to" optional="true" help="Optional. Only if you want to link column entries to local files instead of websites" format="zip,gz,bz2,tar"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
287 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
288 </conditional>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
289 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
290 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
291
3c160414da2e initial upload
shiltemann
parents:
diff changeset
292 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
293 # PDF File #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
294 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
295 <when value="pdf">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
296 <param name="item" type="data" label="PDF File" format="pdf"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
297 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
298 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
299
3c160414da2e initial upload
shiltemann
parents:
diff changeset
300 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
301 # Links #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
302 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
303 <when value="link">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
304 <param name="item" type="data" label="File to link to" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
305 <param name="item2" type="text" size="100" label="link text" help="text to display as a link"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
306 <param name="ireport" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="is the link another iReport?"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
307 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
308 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
309
3c160414da2e initial upload
shiltemann
parents:
diff changeset
310 <when value="links">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
311 <param name="item" type="data" label="Archive with files to link to" help="links will be created to each file in the archive. Supported formats: zip, gz, tar, bz2"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
312 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
313 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
314
3c160414da2e initial upload
shiltemann
parents:
diff changeset
315 <when value="weblink">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
316 <param name="item" type="text" size="100" label="web location to link to " help="url to link to">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
317 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
318 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
319 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
320 <remove value="&amp;"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
321 <remove value=":"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
322 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
323 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
324 <add source="&amp;" target="==amp=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
325 <add source=":" target="==colon=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
326 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
327 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
328 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
329 <param name="item2" type="text" size="100" label="link text" help="text to display as a link"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
330 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
331 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
332
3c160414da2e initial upload
shiltemann
parents:
diff changeset
333 <!--###########################
3c160414da2e initial upload
shiltemann
parents:
diff changeset
334 # Genome Browser #
3c160414da2e initial upload
shiltemann
parents:
diff changeset
335 ########################### -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
336 <when value="genomebrowser">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
337 <!-- TODO: hardcoded server location needed for dalliance to function correctly! Change as needed! -->
3c160414da2e initial upload
shiltemann
parents:
diff changeset
338 <param name="localhost" type="hidden" value="https://bioinf-galaxian.erasmusmc.nl/galaxy">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
339 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
340 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
341 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
342 <remove value=":"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
343 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
344 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
345 <add source=":" target="==colon=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
346 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
347 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
348 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
349
3c160414da2e initial upload
shiltemann
parents:
diff changeset
350 <param name="genomebuild" type="select" label="Select Genome build to be used for Genome Browser" help="A Bio-Dalliance genome browser will be embedded into your iReport ">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
351 <option value="hg18" > hg18 </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
352 <option value="hg19" > hg19 </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
353 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
354 <repeat name="gbtracks" title="Track" default="1" >
3c160414da2e initial upload
shiltemann
parents:
diff changeset
355 <param name="item" type="data" label="file to display" help="Supported formats: bam, vcf, bed, gtf, gff"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
356 <param name="gbfiletype" type="select" label="Select type of file" >
3c160414da2e initial upload
shiltemann
parents:
diff changeset
357 <option value="vcf" > vcf </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
358 <option value="bam" > bam </option>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
359 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
360 <param name="tracklabel" type="text" size="100" value="mytrack" label="track label" help="give your track a name">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
361 <sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
362 <valid initial="default">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
363 <add preset="string.printable"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
364 <remove value=" "/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
365 </valid>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
366 <mapping initial="none">
3c160414da2e initial upload
shiltemann
parents:
diff changeset
367 <add source=" " target="==space=="/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
368 </mapping>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
369 </sanitizer>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
370 </param>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
371 </repeat>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
372 <param name="break" type="boolean" checked="False" truevalue="Y" falsevalue="N" label="Insert break after item?" help="Insert a line break to force next item to appear below this one. If unchecked, the browser will decide layout" />
3c160414da2e initial upload
shiltemann
parents:
diff changeset
373 </when>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
374
3c160414da2e initial upload
shiltemann
parents:
diff changeset
375 </conditional>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
376 </repeat>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
377 </repeat>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
378
3c160414da2e initial upload
shiltemann
parents:
diff changeset
379
3c160414da2e initial upload
shiltemann
parents:
diff changeset
380
3c160414da2e initial upload
shiltemann
parents:
diff changeset
381 </inputs>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
382
3c160414da2e initial upload
shiltemann
parents:
diff changeset
383 <outputs>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
384 <data format="html" name="report" label="iReport: ${label}"/>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
385 </outputs>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
386
3c160414da2e initial upload
shiltemann
parents:
diff changeset
387 <help>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
388 ============
3c160414da2e initial upload
shiltemann
parents:
diff changeset
389 iReport
3c160414da2e initial upload
shiltemann
parents:
diff changeset
390 ============
3c160414da2e initial upload
shiltemann
parents:
diff changeset
391
3c160414da2e initial upload
shiltemann
parents:
diff changeset
392 iReport is a tool for the easy creation of HTML reports from Galaxy datasets. Ideal to use as final step in a pipeline to display all results in a single, interactive report.
3c160414da2e initial upload
shiltemann
parents:
diff changeset
393
3c160414da2e initial upload
shiltemann
parents:
diff changeset
394
3c160414da2e initial upload
shiltemann
parents:
diff changeset
395 **What's new**
3c160414da2e initial upload
shiltemann
parents:
diff changeset
396
3c160414da2e initial upload
shiltemann
parents:
diff changeset
397 - MarkDown support
3c160414da2e initial upload
shiltemann
parents:
diff changeset
398 - HTML content item type
3c160414da2e initial upload
shiltemann
parents:
diff changeset
399 - Link to download entire iReport on cover page
3c160414da2e initial upload
shiltemann
parents:
diff changeset
400
3c160414da2e initial upload
shiltemann
parents:
diff changeset
401
3c160414da2e initial upload
shiltemann
parents:
diff changeset
402
3c160414da2e initial upload
shiltemann
parents:
diff changeset
403 **How to use**
3c160414da2e initial upload
shiltemann
parents:
diff changeset
404
3c160414da2e initial upload
shiltemann
parents:
diff changeset
405 - Specify report title and cover image (url)
3c160414da2e initial upload
shiltemann
parents:
diff changeset
406 - Add any number of named tabs
3c160414da2e initial upload
shiltemann
parents:
diff changeset
407 - Add content items to each tab
3c160414da2e initial upload
shiltemann
parents:
diff changeset
408
3c160414da2e initial upload
shiltemann
parents:
diff changeset
409 1. Text Field
3c160414da2e initial upload
shiltemann
parents:
diff changeset
410 2. Text File
3c160414da2e initial upload
shiltemann
parents:
diff changeset
411 3. PDF File
3c160414da2e initial upload
shiltemann
parents:
diff changeset
412 4. HTML File
3c160414da2e initial upload
shiltemann
parents:
diff changeset
413 5. Table
3c160414da2e initial upload
shiltemann
parents:
diff changeset
414 6. Image File
3c160414da2e initial upload
shiltemann
parents:
diff changeset
415 7. Links (URL/dataset)
3c160414da2e initial upload
shiltemann
parents:
diff changeset
416 8. Links to all files in an archive dataset
3c160414da2e initial upload
shiltemann
parents:
diff changeset
417
3c160414da2e initial upload
shiltemann
parents:
diff changeset
418 **Example History**
3c160414da2e initial upload
shiltemann
parents:
diff changeset
419
3c160414da2e initial upload
shiltemann
parents:
diff changeset
420 http://galaxy-demo.trait-ctmm.cloudlet.sara.nl/u/saskia-hiltemann/h/gcc2014-ireport-about-ireport
3c160414da2e initial upload
shiltemann
parents:
diff changeset
421
3c160414da2e initial upload
shiltemann
parents:
diff changeset
422
3c160414da2e initial upload
shiltemann
parents:
diff changeset
423
3c160414da2e initial upload
shiltemann
parents:
diff changeset
424
3c160414da2e initial upload
shiltemann
parents:
diff changeset
425 </help>
3c160414da2e initial upload
shiltemann
parents:
diff changeset
426 </tool>