annotate clusterBed.xml @ 39:3e38c9b3214f draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
author iuc
date Wed, 01 Sep 2021 11:04:15 +0000
parents dde39ba9c031
children 7ab85ac5f64b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39
3e38c9b3214f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 34
diff changeset
1 <tool id="bedtools_clusterbed" name="bedtools ClusterBed" version="@TOOL_VERSION@" profile="@PROFILE@">
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
2 <description>cluster overlapping/nearby intervals</description>
39
3e38c9b3214f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 34
diff changeset
3 <expand macro="bio_tools" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 </macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <expand macro="stdio" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
9 <command><![CDATA[
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
10 bedtools cluster
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
11 $strand
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
12 -d $distance
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
13 -i '$inputA'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
14 > '$output'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
15 ]]></command>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
16 <inputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
17 <param name="inputA" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
18 <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false" label="Force strandedness."
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 help="That is, only cluster features that are the same strand. By default, this is disabled." />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
20 <param name="distance" argument="-d" type="integer" value="0"
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
21 label="Maximum distance between features allowed for features to be clustered"
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 help="Default is 0. That is, overlapping and/or book-ended features are clustered." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 <outputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
25 <data name="output" format_source="inputA" metadata_source="inputA"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
27 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
28 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
29 <param name="inputA" value="mergedBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
30 <output name="output" file="clusterBed_result.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
31 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
32 </tests>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
33 <help><![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
37
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 .. image:: $PATH_TO_IMAGES/cluster-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 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).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
43
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44 @REFERENCES@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
45 ]]></help>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
46 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
47 </tool>