annotate MirParser.xml @ 0:de6a6afc5a79 draft default tip

Uploaded
author drosofff
date Tue, 24 Jun 2014 12:16:43 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
1 <tool id="MirParser" name="Parse miRNAs" version="0.9.1">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
2 <description>from sRbowtie aligment</description>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
3 <requirements><requirement type='package'>bowtie-inspect</requirement></requirements>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
4 <parallelism method="basic"></parallelism>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
5 <command interpreter="python">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
6 MirParser.py
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
7 #if $refGenomeSource.genomeSource == "history":
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
8 $refGenomeSource.ownFile ## index source sys.arg[1]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
9 --do_not_extract_index ## sys.argv[2]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
10 #else:
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
11 #silent reference= filter( lambda x: str( x[0] ) == str( $input_list.dbkey ), $__app__.tool_data_tables[ 'bowtie_indexes' ].get_fields() )[0][-1]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
12 $reference ## sys.argv[1]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
13 --extract_index ## sys.argv[2]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
14 #end if
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
15 $output1 ## for pre-mirs ## sys.argv[3]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
16 $output2 ## for mature mirs ## sys.argv[4]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
17 $GFF3 ## sys.argv[5]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
18 #if $plotting.plottingOption == "yes":
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
19 $lattice_dataframe ## sys.argv[6]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
20 $plotCode ## sys.argv[7]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
21 $latticePDF ## sys.argv[8]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
22 #else:
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
23 "dummy_dataframe_path" ## sys.argv[6]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
24 "dummy_plotCode" ## sys.argv[7]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
25 "dummy_latticePDF" ## sys.argv[8]
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
26 #end if
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
27 #for $i in $refGenomeSource.input_list
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
28 $i $i.ext "$i.name" ## sys.argv[9,10,11] modulo 3
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
29 #end for
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
30 #silent plottingoption = $plotting.plottingOption
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
31 </command>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
32 <inputs>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
33 <conditional name="refGenomeSource">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
34 <param name="genomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="Built-ins were indexed using default options">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
35 <option value="indexed">Use a built-in index</option>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
36 <option value="history">Use one from the history</option>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
37 </param>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
38 <when value="indexed">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
39 <param name="input_list" type="data" label="Select multiple alignments to parse" multiple="true">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
40 <validator type="dataset_metadata_in_data_table" table_name="bowtie_indexes" metadata_name="dbkey" metadata_column="0" message="database not set for this bowtie output. Select the database(=genome used for matching) manually, or select a reference fasta from your history."/>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
41 </param>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
42 </when>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
43 <when value="history">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
44 <param name="input_list" type="data" label="Select multiple alignments to parse" multiple="true"/>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
45 <param name="ownFile" type="data" format="fasta" label="Select the fasta reference" />
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
46 </when>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
47 </conditional> <!-- refGenomeSource -->
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
48 <param name="GFF3" type="data" label="miRbase GFF3 guide" />
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
49 <conditional name="plotting">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
50 <param name="plottingOption" type="select" label="Additional mir coverage graphs">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
51 <option value="no" selected="True">No</option>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
52 <option value="yes">YES</option>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
53 </param>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
54 <when value="yes">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
55 <param name="display" type="select" label="Display Coverage with absolute number of reads or relatively to the total number of read matching the gene or mir">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
56 <option value="relative" selected="True">Relative Coverage</option>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
57 <option value="absolute">Absolute Coverage</option>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
58 </param>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
59 </when>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
60 </conditional>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
61 </inputs>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
62 <configfiles>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
63 <configfile name="plotCode">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
64 #if $plotting.plottingOption == "yes":
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
65 graph_type = "${plotting.display}" ## "relative" or "absolute"
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
66 ## Setup R error handling to go to stderr
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
67 options( show.error.messages=F,
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
68 error = function () { cat( geterrmessage(), file=stderr() ); q( "no", 1, F ) } )
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
69 library(lattice)
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
70 coverage = read.delim("${lattice_dataframe}", header=T)
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
71 Numb_of_biosamples = length(levels(coverage\$sample))
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
72 if (graph_type=="relative") {
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
73 graph = xyplot(countsNorm~offsetNorm | mir, data=coverage, groups=polarity, col=c("red", "blue"), type="l", lwd=1,
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
74 scales=list(x=list(cex=.5), y=list(cex=.5)), par.strip.text=list(cex=.5), strip=strip.custom(which.given=1, bg="lightblue"), layout=c(Numb_of_biosamples,15), as.table=TRUE, main="miRNA coverage maps")
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
75 } else {
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
76 graph = xyplot(counts~offset | mir, data=coverage, groups=polarity, col=c("red", "blue"), type="l", lwd=1,
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
77 scales=list(x=list(cex=.5), y=list(cex=.5)), par.strip.text=list(cex=.5), strip=strip.custom(which.given=1, bg="lightblue"), layout=c(Numb_of_biosamples,15), as.table=TRUE, main="miRNA coverage maps")
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
78 }
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
79 ## pdf output
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
80 pdf(file="${latticePDF}", paper="special", height=11.69, width=8.2677)
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
81 plot(graph, newpage = T)
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
82 dev.off()
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
83 #end if
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
84 </configfile>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
85 </configfiles>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
86
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
87 <outputs>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
88 <data format="tabular" name="output1" label="Premirs Count Lists"/>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
89 <data format="tabular" name="output2" label="Mature Mirs Count Lists"/>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
90 <data format="tabular" name="lattice_dataframe" label="Lattice Dataframe">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
91 <filter>plotting['plottingOption'] == "yes"</filter>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
92 </data>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
93 <data format="pdf" name="latticePDF" label="Mir coverage">
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
94 <filter>plotting['plottingOption'] == "yes"</filter>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
95 </data>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
96 </outputs>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
97 <help>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
98
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
99 **What it does**
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
100
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
101 This tool uses a specie-specific GFF3 file from mirBase_ to guide the parsing of an alignment file produced with the sRbowtie tool.
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
102
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
103 .. _mirBase: ftp://mirbase.org/pub/mirbase/CURRENT/genomes/
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
104
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
105 ------
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
106
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
107 .. class:: warningmark
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
108
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
109 the Guide GFF3 file must be in the following format:
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
110
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
111 2L . miRNA_primary_transcript 243035 243141 . - . ID=MI0005821;Alias=MI0005821;Name=dme-mir-965
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
112
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
113 2L . miRNA 243055 243076 . - . ID=MIMAT0005480;Alias=MIMAT0005480;Name=dme-miR-965-3p;Derives_from=MI0005821
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
114
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
115 2L . miRNA 243096 243118 . - . ID=MIMAT0020861;Alias=MIMAT0020861;Name=dme-miR-965-5p;Derives_from=MI0005821
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
116
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
117 2L . miRNA_primary_transcript 857542 857632 . + . ID=MI0005813;Alias=MI0005813;Name=dme-mir-375
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
118
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
119 2L . miRNA 857596 857617 . + . ID=MIMAT0005472;Alias=MIMAT0005472;Name=dme-miR-375-3p;Derives_from=MI0005813
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
120
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
121 2L . miRNA 857556 857579 . + . ID=MIMAT0020853;Alias=MIMAT0020853;Name=dme-miR-375-5p;Derives_from=MI0005813
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
122
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
123 2L . miRNA_primary_transcript 1831685 1831799 . - . ID=MI0011290;Alias=MI0011290;Name=dme-mir-2280
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
124
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
125 With name for mature miRNA (3rd column = miRNA) containing either the -3p or -5p string in the attribute Name (Name=dme-miR-965-3p, for instance)
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
126
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
127 ------
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
128
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
129 **Input formats**
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
130
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
131 1. One or sereral alignment files generated with sRbowtie tool and **renamed** according to the name of the biosample (avoid spaces in biosample labels)
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
132
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
133 .. class:: warningmark
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
134
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
135 Alignment datasets generated with sRbowtie must be renamed according to a biosample name
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
136
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
137 2. A GFF3 file retrieved from mirBase_
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
138
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
139 ------
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
140
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
141 **Outputs**
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
142
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
143 Two count list files for counts of reads aligned to pre-mir or mature miRNA
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
144
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
145 A pdf of pre-mir coverages. Red coverages indicate that the mir gene is in the genomic up strand, blue coverages indicate that the mir gene is in the genomic down strand.
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
146
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
147 </help>
de6a6afc5a79 Uploaded
drosofff
parents:
diff changeset
148 </tool>