annotate TFBScluster_candidates_3TFBS.xml @ 1:2f34d5e91bc7 draft

Update to fix README and add some tests.
author pjbriggs
date Wed, 21 Mar 2018 06:34:12 -0400
parents b42da9dc4507
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
2 <tool id="tfbscluster3" name="TFBScluster three TFBS" version="@VERSION@">
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
3 <description>Identifies clusters of three TFBS</description>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
4 <macros>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
5 <import>motif_tools_macros.xml</import>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
6 </macros>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
7 <expand macro="requirements" />
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
8 <command><![CDATA[
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
9 perl $__tool_directory__/TFBScluster_candidates.pl
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
10
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
11 ##TF libraries (comma delimited NO SPACES)
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
12 $lib1,$lib2,$lib3
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
13
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
14 ##Number of flanking 'N's for subject files (comma delimited NO SPACES)
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
15 0,0,0
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
16
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
17 ##Minimum number of occurences (comma delimited NO SPACES)
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
18 $occ1,$occ2,$occ3
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
19
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
20 ##TF IDs (comma delimited NO SPACES)
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
21 $id1,$id2,$id3
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
22
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
23 ##Single range value in bp (+/-) query start and end values
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
24 $range
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
25
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
26 ##Include overlapping TFBSs (include/exclude)
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
27 $overlap
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
28
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
29 ##Output file
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
30 $output
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
31
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
32 > $output_log
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
33
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
34 ]]></command>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
35 <inputs>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
36 <!-- TFBS GFF libraries -->
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
37 <param format="gff" name="lib1" type="data" label="TFBS #1 GFF file" help="Select the first GFF file containing TFBS positions."/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
38 <param format="gff" name="lib2" type="data" label="TFBS #2 GFF file" help="Select the second GFF file containing TFBS positions."/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
39 <param format="gff" name="lib3" type="data" label="TFBS #3 GFF file" help="Select the third GFF file containing TFBS positions."/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
40
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
41 <!-- Min occurrences -->
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
42 <param name="occ1" type="select" label="Minimum occurrence of TFBS #1" help="Select the minimum number of times that an instance of TFBS #1 should be present in a cluster.">
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
43 <option value="1">1</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
44 <option value="2">2</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
45 <option value="3">3</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
46 <option value="4">4</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
47 <option value="5">5</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
48 </param>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
49 <param name="occ2" type="select" label="Minimum occurrence of TFBS #2" help="Select the minimum number of times that an instance of TFBS #2 should be present in a cluster.">
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
50 <option value="1">1</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
51 <option value="2">2</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
52 <option value="3">3</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
53 <option value="4">4</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
54 <option value="5">5</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
55 </param>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
56 <param name="occ3" type="select" label="Minimum occurrence of TFBS #3" help="Select the minimum number of times that an instance of TFBS #3 should be present in a cluster.">
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
57 <option value="1">1</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
58 <option value="2">2</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
59 <option value="3">3</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
60 <option value="4">4</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
61 <option value="5">5</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
62 </param>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
63
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
64 <!-- TFBS identifiers -->
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
65 <param name="id1" type="text" label="Identifier for TFBS #1" value="TFBS1" help="Enter an identifier for TFBS #1." size="20"/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
66 <param name="id2" type="text" label="Identifier for TFBS #2" value="TFBS2" help="Enter an identifier for TFBS #2." size="20"/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
67 <param name="id3" type="text" label="Identifier for TFBS #3" value="TFBS3" help="Enter an identifier for TFBS #3." size="20"/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
68
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
69 <!-- Cluster length -->
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
70 <param name="range" type="text" label="Minimum length of clusters" value="50" help="Enter a number for the minimum length of the clusters, for example 50bp (start to end)" size="5"/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
71
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
72 <!-- Allow overlapping TFBS? -->
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
73 <param name="overlap" type="select" label="Include or exclude overlapping TFBS" help="Decide whether to allow TFBS binding sites to overlap.">
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
74 <option value="exclude">Exclude overlapping TFBS</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
75 <option value="include">Include overlapping TFBS</option>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
76 </param>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
77 </inputs>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
78
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
79 <outputs>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
80 <data format="gff" name="output" label="TFBScluster on ${on_string} (clusters)"/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
81 <data format="txt" name="output_log" label="TFBScluster on ${on_string} (log file)"/>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
82 </outputs>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
83
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
84 <help>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
85 .. class:: infomark
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
86
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
87 **What it does**
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
88
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
89 This tool takes three GFF files containing the positions genomic features, typically transcription factor binding sites (TFBS) and looks for clusters with certain properties. The GFF file input could be different TFBS (e.g. combinatorial binding of different factors) or the same TFBS (clustering of multiple instances of the same factor).
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
90
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
91 The cluster properties are explained in more detail in the **Options** section.
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
92
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
93 ----
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
94
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
95 .. class:: infomark
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
96
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
97 **Options**
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
98
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
99 'TFBS GFF files' - Each file contains genomic coordinates, typically matches between an IUPAC string representing a TFBS and a set of target sequences, such as those from a ChIP-seq experiment. However, the positions could be for any genomic feature over the whole genome. The important thing is that the different files have the same genome build in common.
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
100
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
101 'Minimum occurrence of TFBS' - When clusters are determined you can ensure that a minimum number off occurrences from each TFBS are present.
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
102
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
103 'Identifier for TFBS' - This allows information about the different TFBS sets to be propogated through to the output. The identifier could be the TFBS name or the IUPAC used to search for the sites, this should only include letters/numbers, but without spaces.
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
104
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
105 'Minimum length of clusters' - The length is a window of sequence in which the specified number of TFBS must be located. Initially TFBScluster will identify all cluster matching the input criteria. It will then merge any overlapping clusters, which can result in lengths greater than the input length.
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
106
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
107 'Include or exclude overlapping TFBS' - You can choose to exclude any TFBS that overlaps with another when counting the number of co-occurring TFBS. By default such TFBS are excluded as a basic assumption about co-occuring/cooperative TFBS in a module is that both factors can bind at the same time, which they are unlikely to do if their binding sites overlap.
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
108
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
109 ----
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
110
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
111 .. class:: infomark
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
112
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
113 **Credits**
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
114
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
115 This Galaxy tool has been developed within the Bioinformatics Core Facility at the University of Manchester. It runs the TFBScluster_candidate.pl Perl script that was written by Ian Donaldson, which is a modification of the script from the original web tool. Articles below:
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
116
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
117 http://www.ncbi.nlm.nih.gov/pubmed/15855248
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
118
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
119 http://www.ncbi.nlm.nih.gov/pubmed/16845063
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
120
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
121 Please kindly acknowledge both this Galaxy tool and TFBScluster articles if you use it.
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
122 </help>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
123
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
124 </tool>
b42da9dc4507 Uploaded initial version 1.0.1.
pjbriggs
parents:
diff changeset
125