annotate blockclust.xml @ 4:4882bc140680 draft

Uploaded
author bgruening
date Mon, 21 Oct 2013 12:34:11 -0400
parents
children 49b72f1013b3
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>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
5 </requirements>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
6 <!--<version_command> -version</version_command>-->
4882bc140680 Uploaded
bgruening
parents:
diff changeset
7 <command>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
8 #set $blockclust_data_path = \$BLOCKCLUST_DATA_PATH
4882bc140680 Uploaded
bgruening
parents:
diff changeset
9 #if str($mode.operation) == "pre":
4882bc140680 Uploaded
bgruening
parents:
diff changeset
10 #set $outputdir = $tags_bed.extra_files_path
4882bc140680 Uploaded
bgruening
parents:
diff changeset
11 BlockClustPipeLine.pl -m PRE -bam $mode.reads_bam -tbed $tags_bed;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
12 #end if
4882bc140680 Uploaded
bgruening
parents:
diff changeset
13
4882bc140680 Uploaded
bgruening
parents:
diff changeset
14 #if str($mode.operation) == "clust":
4882bc140680 Uploaded
bgruening
parents:
diff changeset
15 #set $outputdir = $clusters.extra_files_path
4882bc140680 Uploaded
bgruening
parents:
diff changeset
16 #set $accept_bed=list()
4882bc140680 Uploaded
bgruening
parents:
diff changeset
17 #set $reject_bed=list()
4882bc140680 Uploaded
bgruening
parents:
diff changeset
18 ## prepare annotations
4882bc140680 Uploaded
bgruening
parents:
diff changeset
19 #if str($mode.reference) == "hg19":
4882bc140680 Uploaded
bgruening
parents:
diff changeset
20 $accept_bed.append("$blockclust_data_path/annotations/hg19/hg19.accept.bed")
4882bc140680 Uploaded
bgruening
parents:
diff changeset
21 $reject_bed.append("$blockclust_data_path/annotations/hg19/hg19.reject.bed")
4882bc140680 Uploaded
bgruening
parents:
diff changeset
22 #elif str($mode.reference) == "mm10":
4882bc140680 Uploaded
bgruening
parents:
diff changeset
23 $accept_bed.append("$blockclust_data_path/annotations/mm10/mm10.accept.bed")
4882bc140680 Uploaded
bgruening
parents:
diff changeset
24 $reject_bed.append("$blockclust_data_path/annotations/mm10/mm10.reject.bed")
4882bc140680 Uploaded
bgruening
parents:
diff changeset
25 #elif str($mode.reference) == "dm3":
4882bc140680 Uploaded
bgruening
parents:
diff changeset
26 $accept_bed.append("$blockclust_data_path/annotations/dm3/dm3.accept.bed")
4882bc140680 Uploaded
bgruening
parents:
diff changeset
27 $reject_bed.append("$blockclust_data_path/annotations/dm3/dm3.reject.bed")
4882bc140680 Uploaded
bgruening
parents:
diff changeset
28 #end if
4882bc140680 Uploaded
bgruening
parents:
diff changeset
29 BlockClustPipeLine.pl -m TEST -f SEQUENCE -c $blockclust_data_path/blockclust.config
4882bc140680 Uploaded
bgruening
parents:
diff changeset
30 -t $mode.input_bbo
4882bc140680 Uploaded
bgruening
parents:
diff changeset
31 -a #echo ''.join( $accept_bed )
4882bc140680 Uploaded
bgruening
parents:
diff changeset
32 -r #echo ''.join( $reject_bed )
4882bc140680 Uploaded
bgruening
parents:
diff changeset
33 -o $outputdir;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
34 cp #echo os.path.join($outputdir, 'mcl_clusters','all_clusters.bed')# $clusters;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
35 cp #echo os.path.join($outputdir, 'hclust_tree.pdf')# $hclust_plot;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
36 cp #echo os.path.join($outputdir, 'discretized.gspan.tab')# $sim_tab_out;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
37 #end if
4882bc140680 Uploaded
bgruening
parents:
diff changeset
38
4882bc140680 Uploaded
bgruening
parents:
diff changeset
39 #if str($mode.operation) == "post":
4882bc140680 Uploaded
bgruening
parents:
diff changeset
40 #set $outputdir = $clusters_bed.extra_files_path
4882bc140680 Uploaded
bgruening
parents:
diff changeset
41 BlockClustPipeLine.pl -m POST -cbed $mode.clusters_bed -cm $mode.cmsearch_out -tab $mode.sim_tab_in -o $outputdir;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
42 cp #echo os.path.join($outputdir, 'cluster_distribution.pdf')# $cluster_dist;
4882bc140680 Uploaded
bgruening
parents:
diff changeset
43 #end if
4882bc140680 Uploaded
bgruening
parents:
diff changeset
44 </command>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
45 <inputs>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
46 <conditional name="mode">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
47 <param name="operation" type="select" label="Select mode of operation">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
48 <option value="pre">Pre-processing </option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
49 <option value="clust">Clustering</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
50 <option value="post">Post-processing</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
51 </param>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
52 <when value="pre">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
53 <param name="reads_bam" type="data" format="bam" label="BAM file containing alignments" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
54 </when>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
55 <when value="clust">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
56 <param name="input_bbo" type="data" format="tabular" label="Input blockgroups file" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
57 <param name="reference" type="select" label="Select reference genome">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
58 <option value="hg19">Human (hg19)</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
59 <option value="mm10">Mouse (mm10)</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
60 <option value="dm3">Fly (dm3)</option>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
61 </param>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
62 </when>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
63 <when value="post">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
64 <param name="clusters_bed" type="data" format="bed" label="BED file containing clusters (output of BlockClust)" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
65 <param name="cmsearch_out" type="data" format="tabular" label="Output of cmsearch tool" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
66 <param name="sim_tab_in" type="data" format="tabular" label="Pairwise similarities file" />
4882bc140680 Uploaded
bgruening
parents:
diff changeset
67 </when>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
68 </conditional>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
69 </inputs>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
70
4882bc140680 Uploaded
bgruening
parents:
diff changeset
71 <outputs>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
72 <data format="bed" name="tags_bed" label="BlockClust: BAM to BED on ${on_string}">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
73 <filter> mode["operation"]=="pre"</filter>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
74 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
75 <data format="bed" name="clusters" label="BlockClust: Clustering BED on ${on_string}">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
76 <filter> mode["operation"]=="clust"</filter>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
77 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
78 <data format="pdf" name="hclust_plot" label="BlockClust: Hierarchical clustering plot on ${on_string}" >
4882bc140680 Uploaded
bgruening
parents:
diff changeset
79 <filter> mode["operation"]=="clust"</filter>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
80 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
81 <data format="tabular" name="sim_tab_out" label="BlockClust: Pairwise similarities on ${on_string}">
4882bc140680 Uploaded
bgruening
parents:
diff changeset
82 <filter> mode["operation"]=="clust"</filter>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
83 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
84 <data format="tabular" name="analysis" label="BlockClust: Cluster analysis on ${on_string}" >
4882bc140680 Uploaded
bgruening
parents:
diff changeset
85 <filter> mode["operation"]=="post"</filter>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
86 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
87 <data format="pdf" name="cluster_dist" label="BlockClust: Cluster distribution on ${on_string}" >
4882bc140680 Uploaded
bgruening
parents:
diff changeset
88 <filter> mode["operation"]=="post"</filter>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
89 </data>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
90 </outputs>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
91 <help>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
92
4882bc140680 Uploaded
bgruening
parents:
diff changeset
93 .. class:: infomark
4882bc140680 Uploaded
bgruening
parents:
diff changeset
94
4882bc140680 Uploaded
bgruening
parents:
diff changeset
95 **What it does**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
96
4882bc140680 Uploaded
bgruening
parents:
diff changeset
97 Clusters the read profiles (i.e., blockgroups) from the blockbuster tool.
4882bc140680 Uploaded
bgruening
parents:
diff changeset
98
4882bc140680 Uploaded
bgruening
parents:
diff changeset
99 **Inputs**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
100
4882bc140680 Uploaded
bgruening
parents:
diff changeset
101 BlockClust needs output of tool blockbuster as input
4882bc140680 Uploaded
bgruening
parents:
diff changeset
102
4882bc140680 Uploaded
bgruening
parents:
diff changeset
103 **Output**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
104
4882bc140680 Uploaded
bgruening
parents:
diff changeset
105 BlockClust produces a fasta file containing clusters.
4882bc140680 Uploaded
bgruening
parents:
diff changeset
106
4882bc140680 Uploaded
bgruening
parents:
diff changeset
107 ------
4882bc140680 Uploaded
bgruening
parents:
diff changeset
108
4882bc140680 Uploaded
bgruening
parents:
diff changeset
109 **Licenses**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
110
4882bc140680 Uploaded
bgruening
parents:
diff changeset
111 If **BlockClust** is used to obtain results for scientific publications it
4882bc140680 Uploaded
bgruening
parents:
diff changeset
112 should be cited as [1]_.
4882bc140680 Uploaded
bgruening
parents:
diff changeset
113
4882bc140680 Uploaded
bgruening
parents:
diff changeset
114 **References**
4882bc140680 Uploaded
bgruening
parents:
diff changeset
115
4882bc140680 Uploaded
bgruening
parents:
diff changeset
116 .. [1]
4882bc140680 Uploaded
bgruening
parents:
diff changeset
117
4882bc140680 Uploaded
bgruening
parents:
diff changeset
118 ------
4882bc140680 Uploaded
bgruening
parents:
diff changeset
119
4882bc140680 Uploaded
bgruening
parents:
diff changeset
120 </help>
4882bc140680 Uploaded
bgruening
parents:
diff changeset
121 </tool>