annotate history_metadata_extractor.xml @ 1:c7f4f2ac38f2 draft default tip

" master branch Updating"
author lain
date Tue, 09 Aug 2022 15:19:45 +0000
parents 426b0f85a311
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
1 <tool
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
2 id="history_metadata_extractor"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
3 name="History Metadata Extractor"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
4 version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
5 profile="21.09"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
6 >
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
7 <description>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
8 displays information from exported history's jobs_attrs.txt file.
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
9 </description>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
10 <macros>
1
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
11 <token name="@TOOL_VERSION@">0.2.0</token>
0
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
12 <token name="@VERSION_SUFFIX@">0</token>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
13 </macros>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
14 <requirements>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
15 <requirement type="package" version="3.10.5">python</requirement>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
16 </requirements>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
17 <stdio>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
18 <exit_code range="1" level="fatal" description="Missing parameter error" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
19 <exit_code range="2" level="fatal" description="Bad parameter's value" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
20 <exit_code range="3" level="fatal" description="Missing input file" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
21 <exit_code range="4:254" level="fatal" description="Unknown error" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
22 <exit_code range="255" level="fatal" description="No any result to output" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
23 </stdio>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
24 <version_command>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
25 python3 '$__tool_directory__/history_metadata_extractor.py' --version | head -n 1
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
26 </version_command>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
27 <command>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
28 <![CDATA[
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
29 python3 '$__tool_directory__/history_metadata_extractor.py'
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
30 --jobs-attrs '$jobs_attrs'
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
31 --dataset-attrs '$dataset_attrs'
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
32 --output '$history_visu'
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
33 ]]>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
34 </command>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
35 <inputs>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
36 <param
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
37 argument="--jobs-attrs"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
38 type="data"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
39 format="txt"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
40 label="Exported history's jobs_attrs.txt file"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
41 help="Export and extract an history. Select the file 'jobs_attrs.txt'"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
42 />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
43 <param
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
44 argument="--dataset-attrs"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
45 type="data"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
46 format="txt"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
47 label="Exported history's dataset_attrs.txt file"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
48 help="Export and extract an history. Select the file 'dataset_attrs.txt'"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
49 />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
50 </inputs>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
51 <outputs>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
52 <data
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
53 name="history_visu"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
54 format="html"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
55 label="history_visu.html"
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
56 />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
57 </outputs>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
58 <tests>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
59 <test>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
60 <param name="jobs_attrs" value="jobs_attrs.txt" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
61 <param name="dataset_attrs" value="datasets_attrs.txt" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
62 <output name="history_visu" file="out.html" />
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
63 </test>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
64 </tests>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
65 <help><![CDATA[
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
66
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
67 * **@AUTHOR**: Lain Pavot - lain.pavot@inrae.fr
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
68 * **@CREATION DATE**: 22/06/2022
1
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
69 * **@LAST UPDATE DATE**: 08/08/2022
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
70 * **@VERSION**: @TOOL_VERSION@
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
71
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
72 ----
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
73
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
74 ==========================
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
75 History Metadata Extractor
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
76 ==========================
0
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
77
1
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
78 -------
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
79 summary
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
80 -------
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
81
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
82 | This tool xtracts informations from the `jobs_attrs.txt` and
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
83 `datasets_attrs` files in exported histories, and produces an html page
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
84 showing these informations in a kawaii table.
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
85
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
86 -----
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
87 story
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
88 -----
0
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
89
1
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
90 | You have conscientiously stored your Galaxy history exports through the
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
91 years and now need to mine into it. You want to check what has been done
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
92 but you fear the time needed to get all the info by reloading your
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
93 histories into Galaxy for manual mining. You know there is this
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
94 'jobs_attrs.txt' file that contains the golden info, but eh...
0
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
95
1
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
96 | So unfriendly!
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
97
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
98 | Worry no more! The History Metadata Extractor is there for you! Just upload
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
99 your 'jobs_attrs.txt' file and generate a user-friendly summary of the main
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
100 basic info you may be interested in. Tools used, parameters set... The overview
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
101 you have been dreaming of in a nice html file! You're welcome :)
0
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
102
1
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
103 --------------------
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
104 How to use this tool
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
105 --------------------
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
106
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
107 Your exported histories are at the zip format.
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
108 Extract the history you want to visualize, and upload the following files:
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
109
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
110 * jobs_attrs.txt
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
111 * datasets_attrs.txt
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
112
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
113 Run the History Metadata Extractor tool with these input files. You will get a
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
114 HTML file in output. This file can be viewed clicking on the little eye on
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
115 the right of the output card in the output panel.
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
116
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
117 --
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
118
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
119 Love & Unicorns - Lain
c7f4f2ac38f2 " master branch Updating"
lain
parents: 0
diff changeset
120 ]]>
0
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
121 </help>
426b0f85a311 " master branch Updating"
lain
parents:
diff changeset
122 </tool>