Source code

Download source archive ↓

upstream/tools/biom_format/biom_subset_table.xml

1<tool id="biom_subset_table" name="Subset" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
2    <description>a BIOM table</description>
3    <macros>
4        <import>macros.xml</import>
5    </macros>
6    <expand macro="bio_tools"/>
7    <expand macro="requirements" />
8    <expand macro="version_command" />
9    <command detect_errors="exit_code">
10        <![CDATA[
11            biom subset-table
12              --input-json-fp '$input_json_fp'
13              --output-fp '$output_fp'
14              --axis '$axis'
15              --ids '$ids'
16        ]]>
17    </command>
18    <inputs>
19        <param argument="--input-json-fp" type="data" format="biom1" label="BIOM table to subset" />
20        <param argument="--axis" type="select" label="The axis to subset over">
21            <option value="sample" selected="true">Sample</option>
22            <option value="observation">Observation</option>
23        </param>
24        <param argument="--ids" type="data" format="txt,tabular" label="file containing a single column of IDs to retain" />
25    </inputs>
26    <outputs>
27        <data format="biom1" name="output_fp"/>
28    </outputs>
29    <tests>
30        <test>
31            <param name="input_json_fp" value="input_abundance_1.biom1" />
32            <param name="axis" value="sample" />
33            <param name="ids" value="sample_subsetting" />
34            <output name="output_fp" file="subset_samples.biom" ftype="biom1" compare="sim_size"/>
35        </test>
36        <test>
37            <param name="input_json_fp" value="input_abundance_1.biom1" />
38            <param name="axis" value="observation" />
39            <param name="ids" value="observation_subsetting" />
40            <output name="output_fp" file="subset_observations.biom" ftype="biom1" compare="sim_size"/>
41        </test>
42    </tests>
43    <help><![CDATA[
44Subset a BIOM table, over either observations or samples, without fully parsing it. This command is intended to assist in working with very large tables when tight on memory, or as a lightweight way to subset a full table. Currently, it is possible to produce tables with rows or columns (observations or samples) that are fully zeroed.
45    ]]></help>
46    <expand macro="citations" />
47</tool>