annotate blockclust.xml @ 13:bcb191e42032 draft

Uploaded
author rnateam
date Mon, 28 Oct 2013 11:26:22 -0400
parents 69a7a16f26e4
children 0fbc8cdc1cd0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
1 <tool id="blockclust" name="BlockClust" version="0.1">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
2 <description>Non-coding RNA clustering from deep sequencing read profiles</description>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
3 <requirements>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
4 <requirement type="package" version="1.0">blockclust</requirement>
5
49b72f1013b3 Uploaded
rnateam
parents: 4
diff changeset
5 <requirement type="package" version="3.0.1">R_3_0_1</requirement>
49b72f1013b3 Uploaded
rnateam
parents: 4
diff changeset
6 <requirement type="package" version="0.1.19 ">samtools</requirement>
13
bcb191e42032 Uploaded
rnateam
parents: 12
diff changeset
7 <requirement type="package" version="1.0">blockclust_rlibs</requirement>
9
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
8 <requirement type="set_environment">BLOCKCLUST_DATA_PATH</requirement>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
9 </requirements>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
10 <!--<version_command> -version</version_command>-->
4882bc140680 Uploaded
bgruening
parents:
diff changeset
11 <command>
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
12 #if str($tool_mode.operation) == "pre":
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
13 #set $outputdir = $tags_bed.extra_files_path
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
14 BlockClustPipeLine.pl -m PRE -bam $tool_mode.reads_bam -tbed $tags_bed;
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
15 #end if
4882bc140680 Uploaded
bgruening
parents:
diff changeset
16
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
17 #if str($tool_mode.operation) == "clust":
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
18 #set $outputdir = $clusters.extra_files_path
4882bc140680 Uploaded
bgruening
parents:
diff changeset
19 #set $accept_bed=list()
4882bc140680 Uploaded
bgruening
parents:
diff changeset
20 #set $reject_bed=list()
4882bc140680 Uploaded
bgruening
parents:
diff changeset
21 ## prepare annotations
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
22 #if str($tool_mode.reference) == "hg19":
9
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
23 $accept_bed.append("\$BLOCKCLUST_DATA_PATH/annotations/hg19/hg19.accept.bed")
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
24 $reject_bed.append("\$BLOCKCLUST_DATA_PATH/annotations/hg19/hg19.reject.bed")
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
25 #elif str($tool_mode.reference) == "mm10":
9
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
26 $accept_bed.append("\$BLOCKCLUST_DATA_PATH/annotations/mm10/mm10.accept.bed")
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
27 $reject_bed.append("\$BLOCKCLUST_DATA_PATH/annotations/mm10/mm10.reject.bed")
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
28 #elif str($tool_mode.reference) == "dm3":
9
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
29 $accept_bed.append("\$BLOCKCLUST_DATA_PATH/annotations/dm3/dm3.accept.bed")
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
30 $reject_bed.append("\$BLOCKCLUST_DATA_PATH/annotations/dm3/dm3.reject.bed")
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
31 #end if
9
171f6015180f Uploaded
rnateam
parents: 6
diff changeset
32 BlockClustPipeLine.pl -m TEST -f SEQUENCE -c \$BLOCKCLUST_DATA_PATH/blockclust.config
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
33 -t $tool_mode.input_bbo
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
34 -a #echo ''.join( $accept_bed )
4882bc140680 Uploaded
bgruening
parents:
diff changeset
35 -r #echo ''.join( $reject_bed )
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
36 -o $outputdir
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
37 #if str($tool_mode.pred.enable_pred) == "yes":
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
38 -p
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
39 -pm $tool_mode.pred.pred_mode
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
40 -md \$BLOCKCLUST_DATA_PATH/models
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
41 -x 3;
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
42 #if str($tool_mode.pred.pred_mode) == "nearest_neighbour":
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
43 cp #echo os.path.join($outputdir,'nearest_neighbour_predictions.txt')# $nearest_neighbour_pred_bed;
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
44 #elif str($tool_mode.pred.pred_mode) == "model_based":
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
45 cp #echo os.path.join($outputdir,'model_based_predictions.txt')# $model_based_pred_bed;
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
46 #end if
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
47 #else:
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
48 ;
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
49 #end if
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
50
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
51 cp #echo os.path.join($outputdir, 'mcl_clusters','all_clusters.bed')# $clusters;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
52 cp #echo os.path.join($outputdir, 'hclust_tree.pdf')# $hclust_plot;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
53 cp #echo os.path.join($outputdir, 'discretized.gspan.tab')# $sim_tab_out;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
54 #end if
4882bc140680 Uploaded
bgruening
parents:
diff changeset
55
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
56 #if str($tool_mode.operation) == "post":
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
57 #set $outputdir = $clusters_bed.extra_files_path
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
58 BlockClustPipeLine.pl -m POST -cbed $tool_mode.clusters_bed -cm $tool_mode.cmsearch_out -tab $tool_mode.sim_tab_in -o $outputdir;
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
59 cp #echo os.path.join($outputdir, 'cluster_distribution.pdf')# $cluster_dist;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
60 #end if
4882bc140680 Uploaded
bgruening
parents:
diff changeset
61 </command>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
62 <inputs>
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
63 <conditional name="tool_mode">
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
64 <param name="operation" type="select" label="Select mode of operation">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
65 <option value="pre">Pre-processing </option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
66 <option value="clust">Clustering</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
67 <option value="post">Post-processing</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
68 </param>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
69 <when value="pre">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
70 <param name="reads_bam" type="data" format="bam" label="BAM file containing alignments" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
71 </when>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
72 <when value="clust">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
73 <param name="input_bbo" type="data" format="tabular" label="Input blockgroups file" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
74 <param name="reference" type="select" label="Select reference genome">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
75 <option value="hg19">Human (hg19)</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
76 <option value="mm10">Mouse (mm10)</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
77 <option value="dm3">Fly (dm3)</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
78 </param>
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
79 <conditional name="pred">
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
80 <param name="enable_pred" type="select" label="Would you like to perform classification?">
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
81 <option value="no">No</option>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
82 <option value="yes">Yes</option>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
83 </param>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
84 <when value="yes">
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
85 <param name="pred_mode" type="select" label="Mode of classification">
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
86 <option value="model_based">Model based</option>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
87 <option value="nearest_neighbour">Nearest neighbour</option>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
88 </param>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
89 </when>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
90 </conditional>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
91 </when>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
92 <when value="post">
5
49b72f1013b3 Uploaded
rnateam
parents: 4
diff changeset
93 <param name="cmsearch_out" type="data" format="tabular" label="Output of cmsearch tool" />
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
94 <param name="clusters_bed" type="data" format="bed" label="BED file containing clusters (output of BlockClust)" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
95 <param name="sim_tab_in" type="data" format="tabular" label="Pairwise similarities file" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
96 </when>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
97 </conditional>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
98 </inputs>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
99
4882bc140680 Uploaded
bgruening
parents:
diff changeset
100 <outputs>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
101 <data format="bed" name="tags_bed" label="BlockClust: BAM to BED on ${on_string}">
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
102 <filter> tool_mode["operation"]=="pre"</filter>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
103 </data>
5
49b72f1013b3 Uploaded
rnateam
parents: 4
diff changeset
104 <data format="pdf" name="hclust_plot" label="BlockClust: Hierarchical clustering plot on ${on_string}" >
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
105 <filter> tool_mode["operation"]=="clust"</filter>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
106 </data>
5
49b72f1013b3 Uploaded
rnateam
parents: 4
diff changeset
107 <data format="bed" name="clusters" label="BlockClust: Clustering BED on ${on_string}">
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
108 <filter> tool_mode["operation"]=="clust"</filter>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
109 </data>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
110 <data format="bed" name="model_based_pred_bed" label="BlockClust: Model based prediction BED on ${on_string}">
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
111 <filter>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
112 ((
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
113 tool_mode["operation"] == 'clust' and
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
114 tool_mode["pred"]["enable_pred"] == "yes" and
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
115 tool_mode["pred"]["pred_mode"] == "model_based"
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
116 ))
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
117 </filter>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
118 </data>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
119 <data format="bed" name="nearest_neighbour_pred_bed" label="BlockClust: Nearest neighbour prediction BED on ${on_string}">
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
120 <filter>
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
121 ((
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
122 tool_mode["operation"] == 'clust' and
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
123 tool_mode["pred"]["enable_pred"] == "yes" and
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
124 tool_mode["pred"]["pred_mode"] == "nearest_neighbour"
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
125 ))
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
126 </filter>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
127 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
128 <data format="tabular" name="sim_tab_out" label="BlockClust: Pairwise similarities on ${on_string}">
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
129 <filter> tool_mode["operation"]=="clust"</filter>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
130 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
131 <data format="tabular" name="analysis" label="BlockClust: Cluster analysis on ${on_string}" >
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
132 <filter> tool_mode["operation"]=="post"</filter>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
133 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
134 <data format="pdf" name="cluster_dist" label="BlockClust: Cluster distribution on ${on_string}" >
12
69a7a16f26e4 Uploaded
rnateam
parents: 10
diff changeset
135 <filter> tool_mode["operation"]=="post"</filter>
4
4882bc140680 Uploaded
bgruening
parents:
diff changeset
136 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
137 </outputs>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
138 <help>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
139
4882bc140680 Uploaded
bgruening
parents:
diff changeset
140 .. class:: infomark
4882bc140680 Uploaded
bgruening
parents:
diff changeset
141
4882bc140680 Uploaded
bgruening
parents:
diff changeset
142 **What it does**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
143
4882bc140680 Uploaded
bgruening
parents:
diff changeset
144 Clusters the read profiles (i.e., blockgroups) from the blockbuster tool.
4882bc140680 Uploaded
bgruening
parents:
diff changeset
145
4882bc140680 Uploaded
bgruening
parents:
diff changeset
146 **Inputs**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
147
4882bc140680 Uploaded
bgruening
parents:
diff changeset
148 BlockClust needs output of tool blockbuster as input
4882bc140680 Uploaded
bgruening
parents:
diff changeset
149
4882bc140680 Uploaded
bgruening
parents:
diff changeset
150 **Output**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
151
4882bc140680 Uploaded
bgruening
parents:
diff changeset
152 BlockClust produces a fasta file containing clusters.
4882bc140680 Uploaded
bgruening
parents:
diff changeset
153
4882bc140680 Uploaded
bgruening
parents:
diff changeset
154 ------
4882bc140680 Uploaded
bgruening
parents:
diff changeset
155
4882bc140680 Uploaded
bgruening
parents:
diff changeset
156 **Licenses**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
157
4882bc140680 Uploaded
bgruening
parents:
diff changeset
158 If **BlockClust** is used to obtain results for scientific publications it
4882bc140680 Uploaded
bgruening
parents:
diff changeset
159 should be cited as [1]_.
4882bc140680 Uploaded
bgruening
parents:
diff changeset
160
4882bc140680 Uploaded
bgruening
parents:
diff changeset
161 **References**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
162
4882bc140680 Uploaded
bgruening
parents:
diff changeset
163 .. [1]
4882bc140680 Uploaded
bgruening
parents:
diff changeset
164
4882bc140680 Uploaded
bgruening
parents:
diff changeset
165
4882bc140680 Uploaded
bgruening
parents:
diff changeset
166 </help>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
167 </tool>