|
0
|
1
|
|
|
2
|
|
|
3
|
|
|
4 History Metadata Extractor
|
|
|
5 ===
|
|
|
6
|
|
1
|
7 summary
|
|
|
8 ---
|
|
|
9
|
|
|
10 This tool xtracts informations from the `jobs_attrs.txt` and
|
|
|
11 `datasets_attrs` files in exported histories, and produces an html page
|
|
|
12 showing these informations in a kawaii table.
|
|
|
13
|
|
|
14 story
|
|
|
15 ---
|
|
|
16
|
|
|
17 You have conscientiously stored your Galaxy history exports through the
|
|
|
18 years and now need to mine into it. You want to check what has been done
|
|
|
19 but you fear the time needed to get all the info by reloading your
|
|
|
20 histories into Galaxy for manual mining. You know there is this
|
|
|
21 'jobs_attrs.txt' file that contains the golden info, but eh...
|
|
|
22
|
|
|
23 So unfriendly!
|
|
|
24
|
|
|
25 Worry no more! The History Metadata Extractor is there for you! Just upload
|
|
|
26 your 'jobs_attrs.txt' file and generate a user-friendly summary of the main
|
|
|
27 basic info you may be interested in. Tools used, parameters set... The overview
|
|
|
28 you have been dreaming of in a nice html file! You're welcome :)
|
|
|
29
|
|
|
30 How to use this tool
|
|
|
31 ---
|
|
|
32
|
|
|
33 Your exported histories are at the zip format.
|
|
|
34 Extract the history you want to visualize, and upload the following files:
|
|
|
35
|
|
|
36 * jobs_attrs.txt
|
|
|
37 * datasets_attrs.txt
|
|
|
38
|
|
|
39 Run the History Metadata Extractor tool with these input files. You will get a
|
|
|
40 HTML file in output. This file can be viewed clicking on the little eye on
|
|
|
41 the right of the output card in the output panel.
|
|
0
|
42
|
|
|
43
|
|
1
|
44 Each history entry is displayed like the following:
|
|
|
45
|
|
|
46 ```
|
|
|
47 [{ID}] - {tool name} - {tool version}
|
|
|
48 status: {text status}({error code})
|
|
|
49 {table}
|
|
|
50 ```
|
|
|
51 note that `[ID]` is replaced by `[DELETED]` if the dataset has been deleted.
|
|
|
52 the error code can be "None" sometimes, if not provided in the archive.
|
|
|
53
|
|
|
54 The table is always presented like the following:
|
|
|
55 ```
|
|
|
56 | | value | name | extension | hid |
|
|
|
57 | parameters 1 | | | | |
|
|
|
58 | parameters 2 | | | | |
|
|
|
59 | parameters 3 | | | | |
|
|
|
60 | ... | ... | ... | ... | ... |
|
|
|
61 | parameters n | | | | |
|
|
|
62 ```
|
|
|
63
|
|
|
64 The `value` is the textual representation of the parameter provided.
|
|
|
65 For files, the value is not very interesting but the name, extension and
|
|
|
66 history ID should be meaningfull to you.
|
|
|
67 The hid value is the same number as the one found between brackets.
|
|
|
68 So, if a file with hid = 42 has been input to your tool, you can find where
|
|
|
69 this file comes from, from its hid.
|
|
|
70 The only exception is for the `__DATA_FETSH__` tool. This tool is invoked the
|
|
|
71 when the "upload" button is pressed, so the hid for these files will always be
|
|
|
72 "_weird_".
|
|
|
73
|
|
|
74 examples
|
|
|
75 ===
|
|
|
76
|
|
|
77 <div style="width: 760px;">
|
|
|
78
|
|
|
79 Produced tables
|
|
|
80 ---
|
|
|
81
|
|
|
82 Some tables are produced to display the tool's parameters you used.
|
|
|
83
|
|
|
84 
|
|
|
85
|
|
|
86 Tables can be hidden
|
|
|
87 ---
|
|
|
88
|
|
|
89 We can click on the "fold/unforld tables" button to hide/show the tables.
|
|
|
90 The table of one dataset can be fold/unfold when clicking on the title
|
|
|
91 of the dataset (for example: `[42] - __DATA_FETCH__ - 0.1.0`)
|
|
|
92
|
|
|
93 
|
|
|
94
|
|
|
95 Displays only non-deleted datasets
|
|
|
96 ---
|
|
|
97
|
|
|
98 "show/hide deleted" will hide deleted datasets. Re-click it to re-display
|
|
|
99 deleted datasets.
|
|
|
100 
|
|
|
101
|
|
|
102 </div>
|
|
|
103
|
|
|
104 An [example.html](example/example.html) file can be found in the `example`
|
|
|
105 directory.
|
|
0
|
106
|
|
|
107 Metadata
|
|
|
108 ===
|
|
|
109
|
|
|
110 * **@AUTHOR**: Lain Pavot - lain.pavot@inrae.fr
|
|
|
111 * **@CREATION DATE**: 22/06/2022
|
|
1
|
112 * **@LAST UPDATE DATE**: 09/08/2022
|
|
|
113 * **@VERSION**: 0.2.0
|
