annotate qiime_extract_viz.xml @ 0:f1605d46cb42 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
author iuc
date Mon, 13 May 2024 09:25:59 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
1 <tool id="qiime_extract_viz" name="QIIME vizualisation extractor" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="22.01" license="MIT">
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
2 <description></description>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
3 <macros>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
4 <token name="@TOOL_VERSION@">0.1.0</token>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
6 </macros>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
7 <edam_topics>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
8 <edam_topic>topic_3174</edam_topic><!-- metagenomics -->
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
9 </edam_topics>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
10 <edam_operations>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
11 <edam_operation>operation_2422</edam_operation> <!-- Data retrieval -->
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
12 </edam_operations>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
13 <requirements>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
14 <requirement type="package" version="6.0">unzip</requirement>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
15 </requirements>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
16 <command detect_errors="exit_code"><![CDATA[
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
17 unzip '$infile' "*/data/*" &&
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
18 mkdir -p '${viz.extra_files_path}' &&
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
19 mv '$infile.metadata.uuid'/data/* '${viz.extra_files_path}' &&
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
20
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
21 ## the html file use <script src="./data.jsonp" charset="utf-8"></script>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
22 ## Galaxy sets application/octet-stream as mime type for which browsers
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
23 ## refuse to include the file. Therefore we replace the extensions by js
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
24 ## for which Galaxy sets the appropriate mime type
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
25 for nonjs in \$(cat '${viz.extra_files_path}'/*.html | grep '<script src="' | sed 's/^\s*<script src="//; s/".*//' | grep -v "\.js\$"); do
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
26 js=\$(echo "\$nonjs" | sed 's/\.[^.]\+$//').js &&
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
27 mv '${viz.extra_files_path}'"/\$nonjs" '${viz.extra_files_path}'"/\$js" &&
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
28 sed -i -e "s@\"\${nonjs}\"@\"\${js}\"@" '${viz.extra_files_path}'/*.html;
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
29 done &&
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
30
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
31 mv '${viz.extra_files_path}'/index.html '$viz'
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
32 ]]></command>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
33 <inputs>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
34 <param name="infile" type="data" format="qzv" label="QIIME visualization artifact" />
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
35 </inputs>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
36 <outputs>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
37 <data name="viz" format="html"/>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
38 </outputs>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
39 <tests>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
40 <!-- the first test use the test data from the galaxy datatypes module
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
41 where the html file just contains 43 -->
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
42 <test>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
43 <param name="infile" value="qiime2.qzv" ftype="qzv"/>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
44 <output name="viz">
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
45 <assert_contents>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
46 <has_text text="43"/>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
47 </assert_contents>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
48 </output>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
49 </test>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
50 <test>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
51 <param name="infile" value="demux-summ.qzv" ftype="qzv"/>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
52 <output name="viz">
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
53 <assert_contents>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
54 <has_text text="html"/>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
55 </assert_contents>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
56 </output>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
57 </test>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
58 </tests>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
59 <help><![CDATA[
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
60
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
61 .. class:: infomark
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
62
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
63 **What it does**
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
64
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
65 The tool extracts visualisation from QIIME visualisation artifact datasets (qzv).
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
66
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
67 QIIME visualisation artifact files are zip files that contain visualisations of the data
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
68 which is extracted by this tool.
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
69
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
70 Note that Galaxy contains a Display application that uses
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
71 https://view.qiime2.org/ to show this data. For non-public Galaxy instances this
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
72 does not work.
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
73
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
74 ]]></help>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
75 <citations>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
76 <citation type="doi">10.1038/s41587-019-0209-9</citation>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
77 </citations>
f1605d46cb42 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/qiimme_extract_viz commit 19abce82000b612039fa835391a6fb9328368d73
iuc
parents:
diff changeset
78 </tool>