annotate macros.xml @ 2:33a0ff1bb7df draft

"planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 2df36b6d30fd69ea532a4fd42daf4741363074f3"
author iuc
date Sun, 28 Jun 2020 14:50:52 -0400
parents 3bdd8fa109b1
children 0defe443ea04
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
2 <macros>
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
3 <token name="@TOOL_VERSION@">3.1.3</token>
1
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
4 <token name="@TOOL_NAME@">ont_fast5_api:</token>
0
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
5 <xml name="requirements">
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
6 <requirements>
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
7 <requirement type="package" version="@TOOL_VERSION@">ont-fast5-api</requirement>
1
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
8 <requirement type="package" version="1.10.5">hdf5</requirement>
0
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
9 </requirements>
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
10 </xml>
1
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
11
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
12 <!-- command -->
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
13 <token name="@BATCHSIZE@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
14 --batch_size $batch_size
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
15 ]]></token>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
16 <token name="@COMPRESSION@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
17 #if $compression != 'none'
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
18 --compression '$compression'
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
19 #end if
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
20 ]]></token>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
21 <token name="@INITIALIZE@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
22 mkdir -p './data' &&
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
23 tar -xf '$input_path' -C './data' &&
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
24 ]]></token>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
25 <token name="@INPUTPATH@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
26 --input_path './data'
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
27 ]]></token>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
28 <token name="@SAVEPATH@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
29 --save_path './results'
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
30 ]]></token>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
31 <token name="@TARBALL@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
32 && find './results' -type f -name '*.fast5' | tar --transform 's/.*\///g' -cvf './results.fast5.tar' --files-from=/dev/stdin
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
33 ]]></token>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
34 <token name="@THREADS@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
35 --threads \${GALAXY_SLOTS:-4}
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
36 ]]></token>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
37
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
38 <!-- input -->
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
39 <xml name="input" token_argument="--input_path" token_label="multi">
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
40 <param argument="@ARGUMENT@" type="data" format="fast5.tar" label="Select @LABEL@ read input file"/>
0
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
41 </xml>
1
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
42 <xml name="batch_size">
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
43 <param argument="--batch_size" type="integer" value="4000" min="1" label="Set batch size" help="Number of single reads to include in each multi read file"/>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
44 </xml>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
45 <xml name="compression">
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
46 <param argument="compression" type="select" label="Select output compression type">
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
47 <yield/>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
48 <option value="vbz_legacy_v0">VBZ legacy v0</option>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
49 <option value="gzip">GZIP</option>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
50 </param>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
51 </xml>
0
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
52
1
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
53 <!-- output -->
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
54 <xml name="output">
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
55 <data name="out_results" format="fast5.tar" from_work_dir="results.fast5.tar" label="${tool.name} on ${on_string}: Results"/>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
56 </xml>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
57
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
58 <!-- help -->
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
59 <token name="@WID@"><![CDATA[
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
60 *ont_fast5_api* is a simple interface to HDF5 files of the Oxford Nanopore FAST5 file format.
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
61
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
62 - concrete implementation of the FAST5 file schema using the generic h5py library
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
63 - plain-english-named methods to interact with and reflect the FAST5 file schema
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
64 - tools to convert between multi_read and single_read formats
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
65 - tools to compress/decompress raw data in files
0
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
66 ]]></token>
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
67 <token name="@REFERENCES@"><![CDATA[
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
68 More information are available on `github <https://github.com/nanoporetech/ont_fast5_api>`_.
eb1f4aa80c72 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit 84504d6786e9edf00367739210d6bae78cb42cc8"
iuc
parents:
diff changeset
69 ]]></token>
1
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
70
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
71 <xml name="citations">
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
72 <citations>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
73 <citation type="bibtex">
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
74 @online{ont_fast5_api,
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
75 author = {Oxford Nanopore Technologies },
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
76 title = {ont_fast5_api},
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
77 year = 2020,
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
78 url = {https://github.com/nanoporetech/ont_fast5_api},
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
79 urldate = {2020-06-01}
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
80 }</citation>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
81 </citations>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
82 </xml>
3bdd8fa109b1 "planemo upload for repository https://github.com/nanoporetech/ont_fast5_api/ commit a5d038871ff0e1b133039b59183dee795449b383"
iuc
parents: 0
diff changeset
83 </macros>