Mercurial > repos > iuc > hal_halextract

comparison hal_halExtract.xml @ 0:ea84fd77a2d2 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/haltools commit 6244b9d15a5ad97ae20191e2f8fbafe2050c3cac
author iuc
date Fri, 06 Feb 2026 10:34:37 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:ea84fd77a2d2
1 <tool id="hal_halextract" name="halExtract" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
2 <description>can be used to copy between formats</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <expand macro="requirements"/>
7 <expand macro="stdio"/>
8 <command detect_errors="aggressive"><![CDATA[
9 halExtract
10 #if $root:
11 --root '$root'
12 #end if
13 #if $outputFormat.type == 'mmap':
14 --outputFormat 'mmap'
15 --mmapFileSize $outputFormat.mmapFileSize
16 #else if $outputFormat.type == 'hdf5':
17 --outputFormat 'hdf5'
18 #end if
19 '$input_hal' '$output_file'
20 ]]></command>
21 <inputs>
22 <expand macro="input_hal"/>
23 <expand macro="params_root_optional"/>
24 <conditional name="outputFormat">
25 <param name="type" type="select" label="Output storage format">
26 <!--
27 At the moment, creating a HAL file in mmap format is disabled. The creation in HDF5 format is enforced.
28 <option value="Same as input" selected="true">Same as input file</option>
29 <option value="mmap">mmap</option>
30 -->
31 <option value="hdf5" selected="true">HDF5</option>
32 </param>
33 <when value="hdf5"/>
34 <!--
35 <when value="Same as input"/>
36 <when value="mmap">
37 <expand macro="params_mmap_size"/>
38 </when>
39 -->
40 </conditional>
41 </inputs>
42 <outputs>
43 <data name="output_file" format="hal" label="${tool.name} on ${on_string}: ${outputFormat.type}"/>
44 </outputs>
45 <tests>
46 <test expect_num_outputs="1">
47 <param name="input_hal" value="halTest.hal"/>
48 <output name="output_file" ftype="hal">
49 <assert_contents>
50 <has_size min="50000"/>
51 </assert_contents>
52 </output>
53 <assert_stdout>
54 <has_text text="Extracting Genome_0"/>
55 </assert_stdout>
56 </test>
57 <!--
58 Disabled until mmap HAL format is allowed
59 <test expect_num_outputs="1">
60 <param name="input_hal" value="halTest.hal"/>
61 <conditional name="outputFormat">
62 <param name="type" value="mmap"/>
63 <param name="mmapFileSize" value="1"/>
64 </conditional>
65 <assert_stdout>
66 <has_text text="Extracting Genome_0"/>
67 </assert_stdout>
68 </test>
69 -->
70 <test expect_num_outputs="1">
71 <param name="input_hal" value="halTest.hal"/>
72 <param name="root" value="Genome_1"/>
73 <output name="output_file" ftype="hal">
74 <assert_contents>
75 <has_size min="20000"/>
76 </assert_contents>
77 </output>
78 <assert_stdout>
79 <has_text text="Extracting Genome_1"/>
80 </assert_stdout>
81 </test>
82 </tests>
83 <help><![CDATA[
84 halExtract copies HAL files between different storage formats, such as HDF5 and mmap.
85 It reads an input HAL file and writes an output HAL file in the desired format, optionally extracting a subtree rooted at a specified genome.
86
87 - **HDF5** is standard container format for larger data sets with good compression characteristics.
88 - The **mmap** format stores the raw data structures in a file, which is accessed by mapping it in memory using the mmap system call. HAL files in the mmap format are considerably bigger but often much faster to access.
89
90 -----
91
92 .. class:: warningmark
93
94 At the moment, extraction to mmap format is disabled. The extraction to HDF5 format is enforced.
95 ]]></help>
96 <expand macro="citation"/>
97 <expand macro="creator"/>
98 </tool>