annotate dbkit_create.xml @ 0:0dcdeb1d3d0a draft

"planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
author guerler
date Tue, 23 Mar 2021 23:03:55 +0000
parents
children 720df348813f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
1 <tool id="ffindex_dbkit_create" name="DBKit Create" version="0.1.1" license="MIT" profile="20.01">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
2 <description>database</description>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
3 <macros>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
4 <import>macros.xml</import>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
5 </macros>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
6 <expand macro="requirements" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
8 mkdir -p inputs &&
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
9 #for item in $inputs
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
10 ln -s '${item}' 'inputs/${item.element_identifier}' &&
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
11 #end for
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
12 dbkit_create.py
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
13 -l '$input'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
14 -p 'inputs'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
15 -o '$index'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
16 -d '$database'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
17 -g '$log'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
18 -il '$advanced.idlength'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
19 -ic '$advanced.idcase'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
20 -ie '$advanced.idextension'
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
21 ]]> </command>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
22 <inputs>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
23 <param name="input" type="data" format="tabular" label="List of Identifiers" help="Specify a list containing all entry identifiers to be downloaded." />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
24 <param name="inputs" type="data" format="txt" multiple="true" label="Specify your datasets" help="The datasets that you want to convert into an ffindex." />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
25 <conditional name="advanced">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
26 <param name="type" type="select" label="Identifier Formatting Options" help="">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
27 <option value="true">Yes, I want to format my identifiers</option>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
28 <option value="false">No formatting</option>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
29 </param>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
30 <when value="true">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
31 <param name="idextension" type="text" optional="true" label="Identifier Extensions" help="Specify the extension of the identifier" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
32 <param name="idlength" type="integer" label="Identifier Length" value="0" min="0" max="20" help="Specify the length of the identifier (disable=0)." />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
33 <param name="idcase" type="select" label="Identifier Case" display="radio" help="Choose to format the identifier by changing its case (optional).">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
34 <option value="">Unformatted</option>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
35 <option value="lower">Lower</option>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
36 <option value="upper">Upper</option>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
37 </param>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
38 </when>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
39 <when value="false">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
40 <param name="idextension" type="hidden" value="" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
41 <param name="idlength" type="hidden" value="0" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
42 <param name="idcase" type="hidden" value="" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
43 </when>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
44 </conditional>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
45 <expand macro="logfile" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
46 </inputs>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
47 <outputs>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
48 <data name="index" format="ffindex" label="DBKit Index" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
49 <data name="database" format="ffdata" label="DBKit Database" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
50 <data format="txt" name="log" label="DBKit Log">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
51 <filter>logfile</filter>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
52 </data>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
53 </outputs>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
54 <tests>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
55 <test>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
56 <param name="input" value="create/sequences.tabular" ftype="tabular" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
57 <param name="inputs" value="create/NP_000282.1.hhr,create/NP_000290.2.hhr,create/NP_000548.2.hhr,create/NP_000836.2.hhr" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
58 <conditional name="advanced">
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
59 <param name="type" value="false" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
60 </conditional>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
61 <output name="index" file="create/sequences.ffindex" ftype="ffindex" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
62 <output name="database" file="create/sequences.ffdata" ftype="ffdata" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
63 </test>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
64 </tests>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
65 <help><![CDATA[
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
66
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
67 **What it does**
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
68
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
69 This database creation tool downloads entries from an external resource and creates a datasets with all its contents. Additionally an index file is
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
70 generated indicating the start and size of every entry within the database file. The tool can also operate on collections.
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
71 ]]> </help>
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
72 <expand macro="citations" />
0dcdeb1d3d0a "planemo upload commit b68cb41b1884703c4f1574b65a6408d7d0cca321"
guerler
parents:
diff changeset
73 </tool>