annotate clusterBed.xml @ 12:c782e0edc4f1 draft default tip

Uploaded
author bgruening
date Thu, 19 Jun 2014 10:12:00 -0400
parents e526617a6bb9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
1 <tool id="bedtools_clusterbed" name="ClusterBed" version="@WRAPPER_VERSION@.0">
11
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
9 bedtools cluster
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
10 $strand
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
11 -d $distance
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
12 -i $inputA
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
13 &gt; $output
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
14 </command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
15 <inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
16 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
12
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
17 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue="" label="Force strandedness."
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
18 help="That is, only cluster features that are the same strand. By default, this is disabled." />
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
19 <param name="distance" type="integer" value="0"
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
20 label="Maximum distance between features allowed for features to be clustered"
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
21 help="Default is 0. That is, overlapping and/or book-ended features are clustered." />
11
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
22 </inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
23 <outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
24 <data format_source="inputA" name="output" metadata_source="inputA" label=""/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
25 </outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
26 <help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
27
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
28 **What it does**
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
29
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
30 Similar 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.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
31
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
32 .. image:: $PATH_TO_IMAGES/cluster-glyph.png
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
33
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
34 .. class:: warningmark
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
35
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
36 bedtools 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).
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
37
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
38 @REFERENCES@
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
39 </help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
40 </tool>