annotate MirParser.xml @ 7:20b8ff9c1cb9 draft default tip

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