Source code

Download source archive ↓

upstream-extended/iuc/tools/bedtools/clusterBed.xml

1<tool id="bedtools_clusterbed" name="bedtools ClusterBed" version="@TOOL_VERSION@" profile="@PROFILE@">
2    <description>cluster overlapping/nearby intervals</description>
3    <macros>
4        <import>macros.xml</import>
5    </macros>
6    <expand macro="bio_tools" />
7    <expand macro="requirements" />
8    <expand macro="stdio" />
9    <command><![CDATA[
10bedtools cluster
11$strand
12-d $distance
13-i '$inputA'
14> '$output'
15    ]]></command>
16    <inputs>
17        <param name="inputA" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
18        <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false" label="Force strandedness."
19            help="That is, only cluster features that are the same strand. By default, this is disabled." />
20        <param name="distance" argument="-d" type="integer" value="0"
21            label="Maximum distance between features allowed for features to be clustered"
22            help="Default is 0. That is, overlapping and/or book-ended features are clustered." />
23    </inputs>
24    <outputs>
25        <data name="output" format_source="inputA" metadata_source="inputA"/>
26    </outputs>
27    <tests>
28        <test>
29            <param name="inputA" value="mergedBed1.bed" ftype="bed" />
30            <output name="output" file="clusterBed_result.bed" ftype="bed" />
31        </test>
32    </tests>
33    <help><![CDATA[
34**What it does**
35
36Similar to merge, cluster report each set of overlapping or “book-ended” features in an interval file. In contrast to merge, cluster does not flatten the cluster of intervals into a new meta-interval; instead, it assigns an unique cluster ID to each record in each cluster. This is useful for having fine control over how sets of overlapping intervals in a single interval file are combined.
37
38.. image:: $PATH_TO_IMAGES/cluster-glyph.png
39
40.. class:: warningmark
41
42bedtools cluster requires that you presort your data by chromosome and then by start position (e.g., sort -k1,1 -k2,2n in.bed > in.sorted.bed for BED files).
43
44@REFERENCES@
45    ]]></help>
46    <expand macro="citations" />
47</tool>