annotate ALFA/alfa_wrapper.xml @ 20:a74f6350f32e draft

Uploaded
author charles-bernard
date Tue, 11 Oct 2016 11:08:55 -0400
parents a1e2ab10b317
children 1714165f5df0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
1 <tool id="alfa" name="ALFA" version="0.1.0">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
2 <description>- Compute and display distribution of reads by genomic categories</description>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
3
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
4 <!-- ALFA requires bedtools suite v2.20.0 and above -->
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
5 <requirements>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
6 <requirement type="package" version="2.24">bedtools</requirement>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
7 <requirement type="package" version="1.2">samtools</requirement>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
8 <requirement type="package" version="1.4">matplotlib</requirement>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
9 </requirements>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
10
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
11 <command interpreter="bash">
20
a74f6350f32e Uploaded
charles-bernard
parents: 18
diff changeset
12 alfa_wrapper.sh $__root_dir__ $__tool_directory__ $ALFA_config $logReport
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
13 </command>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
14
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
15 <inputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
16 <param name="projectName" value="ALFA" type="text" size="20" label="Project Name">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
17 <validator type="empty_field" message="Please, specify a name for your project."/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
18 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
19
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
20 <section name="annotation" title="INPUT 1: Annotation File (GTF format)" expanded="True">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
21 <conditional name="annotationSource">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
22 <param name="annotationSourceSelection" type="select" label="Select the source of your annotated sequence/genome">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
23 <option value="personal_gtf" selected="true">Personal annotation file (GTF format)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
24 <option value="index">Stranded and Unstranded Indexes previously generated by ALFA (Index format)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
25 <option value="built_in_index">Built-in indexes among a list of referenced genome (Index format)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
26 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
27 <when value="personal_gtf">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
28 <param name="annotationFile" type="data" format="Gff, Gtf" label="Select your personal annotation file (GTF format)">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
29 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
30 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
31 <when value="index">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
32 <param name="strandedIndex" type="data" format="index" label="Select your ALFA stranded index file (index format)"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
33 <param name="unstrandedIndex" type="data" format="index" label="Select your ALFA Unstranded index file (index format)"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
34 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
35 <when value="built_in_index">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
36 <param name="built_in_index_prefix" type="select" label="Select Genome">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
37 <options from_data_table="alfa_indexes">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
38 <validator type="no_options" message="No indexes are available for the selected input dataset" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
39 </options>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
40 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
41 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
42 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
43 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
44
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
45 <section name="reads" title="INPUT 2: Aligned Reads File(s) of the annotated sequence (BAM or BEDGRAPH format)" expanded="True">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
46 <conditional name="readsType">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
47 <param name="readsTypeSelection" type="select" label="Select the format of the reads file(s)">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
48 <option value="bam" selected="true">BAM</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
49 <option value="bedgraph">BEDGRAPH</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
50 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
51 <when value="bam">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
52 <repeat name="readsList" title="Reads File" min="1" >
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
53 <param name="readsFile" type="data" format="Bam" label="Select the reads file of your annotated sequence (BAM format)"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
54 <param name="readsLabel" type="text" size="20" value="" label="Label of the reads" optional="True"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
55 </repeat>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
56 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
57 <when value="bedgraph">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
58 <repeat name="readsList" title="Reads File" min="1">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
59 <param name="readsFile" type="data" format="Bed" label="Select the reads file of your annotated sequence (BEDGRAPH format)"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
60 <param name="readsLabel" type="text" size="20" value="" label="Label of the reads" optional="True"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
61 </repeat>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
62 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
63 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
64 <param name="strandness" type="select" label="Select the strandness of your mapped reads dataset">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
65 <option value="unstranded" selected="true">Unstranded (reads will match genomic features on both forward and reverse strands of the annotated sequence)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
66 <option value="forward">Forward (reads will match only genomic features on the forward strand of the annotated sequence)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
67 <option value="reverse">Reverse (reads will match only genomic features on the reverse strand of the annotated sequence)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
68 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
69 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
70
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
71 <section name="outputFiles" title="OUTPUT FILES: Choose the output files" expanded="False">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
72 <param name="plot" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Categories and Biotypes Histograms" help="Plot the nucleotides distribution of the reads per genomic categories and biotypes"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
73 <param name="countFile" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Categories Count File" help="Edit the exact count of nucleotides in the reads per genomic categories and biotypes"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
74 <param name="index" type="boolean" truevalue="True" falsevalue="False" checked="False" label ="Indexes" help="Print the resulting stranded and unstranded indexes from the gtf input file (useful if you plan to run ALFA again with this annotated sequence)"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
75 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
76
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
77 <section name="outputOptions" title="ADVANCED OPTIONS" expanded="False">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
78 <param name="categoriesDepth" type="select" label="Categories to Display">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
79 <option value="1">gene | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
80 <option value="2">exon | intron | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
81 <option value="3" selected="true">5’-UTR | CDS | 3’-UTR | intron | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
82 <option value="4">5’-UTR | start_codon | CDS | stop_codon | 3’-UTR | intron | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
83 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
84 <param name="plotFormat" type="select" label="Plot Options: Select graph format" help="Ignore if you did not choose the histograms output file">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
85 <option value="pdf" selected="true">pdf</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
86 <option value="svg">svg</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
87 <option value="png">png</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
88 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
89 <conditional name="plotThreshold">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
90 <param name="plotThresholdChoice" type="boolean" truevalue="True" falsevalue="False" checked="false" label="Plot Options: Modify y axis range of the normalized counts of bio-features" help="Ignore if you did not choose the histograms output file"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
91 <when value="True">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
92 <param name="yMin" type="float" value="-2.0" label="y min"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
93 <param name="yMax" type="float" value="2.0" label="y max"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
94 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
95 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
96 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
97 </inputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
98
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
99 <outputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
100 <data name="logReport" format="txt" label="${projectName}-Log Report"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
101 <data name="outputPdf" format="pdf" label="${projectName}-BioFeatures Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
102 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'pdf'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
103 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
104 <data name="outputCategoriesPng" format="png" label="${projectName}-Categories Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
105 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'png'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
106 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
107 <data name="outputBiotypesPng" format="png" label="${projectName}-Biotypes Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
108 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'png'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
109 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
110 <data name="outputCategoriesSvg" format="svg" label="${projectName}-Categories Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
111 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'svg'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
112 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
113 <data name="outputBiotypesSvg" format="svg" label="${projectName}-Biotypes Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
114 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'svg'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
115 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
116 <data name="outputCountFile" format="txt" label="${projectName}-Categories Count">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
117 <filter>outputFiles['countFile'] is True</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
118 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
119 <data name="outputStrandedIndex" format="txt" label="${projectName}-Stranded Index">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
120 <filter>outputFiles['index'] is True</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
121 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
122 <data name="outputUnstrandedIndex" format="txt" label="${projectName}-Unstranded Index">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
123 <filter>outputFiles['index'] is True</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
124 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
125 </outputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
126
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
127 <configfiles>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
128 <configfile name="ALFA_config">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
129 projectName=$projectName
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
130
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
131 ##__INPUT 1__##
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
132 annotationSource=$annotation.annotationSource['annotationSourceSelection']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
133 #if str ( $annotation.annotationSource['annotationSourceSelection'] ) == "index"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
134 annotationFile=None
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
135 strandedIndex=$annotation.annotationSource['strandedIndex']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
136 unstrandedIndex=$annotation.annotationSource['unstrandedIndex']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
137 #else if str ( $annotation.annotationSource['annotationSourceSelection'] ) == "built_in_index"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
138 annotationFile=None
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
139 built_in_index_prefix=$annotation.annotationSource.built_in_index_prefix.fields.prefix
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
140 #else
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
141 annotationFile=$annotation.annotationSource['annotationFile']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
142 strandedIndex=None
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
143 unstrandedIndex=None
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
144 #end if
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
145
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
146 ##__INPUT 2__##
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
147 readsType=$reads.readsType['readsTypeSelection']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
148 #for $i, $r in enumerate ( $reads.readsType['readsList'] )
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
149 readsFile[$i]=$r.readsFile
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
150 readsLabel[$i]=$r.readsLabel
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
151 #end for
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
152 strandness=$reads['strandness']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
153
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
154 ##__OUTPUT FILES__##
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
155 plotChoice=$outputFiles['plot']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
156 countFileChoice=$outputFiles['countFile']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
157 indexChoice=$outputFiles['index']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
158
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
159 outputPdf=$outputPdf
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
160 outputCategoriesPng=$outputCategoriesPng
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
161 outputBiotypesPng=$outputBiotypesPng
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
162 outputCategoriesSvg=$outputCategoriesSvg
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
163 outputBiotypesSvg=$outputBiotypesSvg
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
164 outputCountFile=$outputCountFile
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
165 outputStrandedIndex=$outputStrandedIndex
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
166 outputUnstrandedIndex=$outputUnstrandedIndex
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
167
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
168 ##__OUTPUT OPTIONS__##
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
169 categoriesDepth=$outputOptions['categoriesDepth']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
170 plotFormat=$outputOptions['plotFormat']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
171 plotThresholdChoice=$outputOptions.plotThreshold['plotThresholdChoice']
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
172 #if str ( $outputOptions.plotThreshold['plotThresholdChoice'] ) == "True"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
173 yMin=$outputOptions.plotThreshold.yMin
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
174 yMax=$outputOptions.plotThreshold.yMax
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
175 #else
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
176 yMin=None
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
177 yMax=None
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
178 #end if
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
179 </configfile>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
180 </configfiles>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
181
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
182 <tests>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
183 <test>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
184 <param name="alfa_toy" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
185 <section name="annotation">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
186 <conditional name="annotationSource">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
187 <param name="annotationSourceSelection" value="personal_gtf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
188 <param name="annotationFile" value="alfa_toy.gtf" ftype="gtf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
189 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
190 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
191 <section name="reads">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
192 <conditional name="readsType">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
193 <param name="readsTypeSelection" value="bam" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
194 <repeat name="readsList">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
195 <param name="readsFile" value="alfa_toy.bam" ftype="bam" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
196 <param name="readsLabel" value="alfa_toy" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
197 </repeat>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
198 <param name="strandness" value="unstranded" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
199 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
200 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
201 <section name="outputFiles">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
202 <param name="plot" value="True" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
203 <param name="countFile" value="True" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
204 <param name="index" value="True" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
205 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
206 <section name="outputOptions">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
207 <param name="categoriesDepth" value="3" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
208 <param name="plotFormat" value="pdf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
209 <conditional name="plotThreshold">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
210 <param name="plotThresholdChoice" value="False" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
211 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
212 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
213 <output name="outputPdf" file="alfa_toy-Biofeatures Distribution.pdf" ftype="pdf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
214 <output name="outputCountFile" file="alfa_toy.categories_count" ftype="txt" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
215 <output name="outputStrandedIndex" file="alfa_toy.stranded.index" ftype="txt" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
216 <output name="outputUnstrandedIndex" file="alfa_toy.unstranded.index" ftype="txt" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
217 <assert_stdout>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
218 <has_text text="### End of the program" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
219 </assert_stdout>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
220 </test>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
221 </tests>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
222
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
223 <help>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
224 **ALFA acronym**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
225
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
226 - Annotation.Landscape.For.Aligned reads
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
227
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
228 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
229
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
230 **What it does**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
231
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
232 | ALFA provides a global overview of features distribution composing New Generation Sequencing dataset(s).
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
233 |
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
234 | Given a set of aligned reads (BAM files) and an annotation file (GTF format), the tool produces plots of the raw and normalized distributions of those reads among genomic categories (stop codon, 5'-UTR, CDS, intergenic, etc.) and biotypes (protein coding genes, miRNA, tRNA, etc.). Whatever the sequencing technique, whatever the organism.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
235
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
236 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
237
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
238 **Official documentation of the tool**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
239
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
240
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
241 - https://github.com/biocompibens/ALFA
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
242
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
243 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
244
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
245 **Detailed example**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
246
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
247 - https://github.com/biocompibens/ALFA#detailed-example
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
248
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
249 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
250
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
251 **Nota Bene**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
252
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
253 1. **Input 1: Annotation File**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
254
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
255
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
256 | ALFA requires as first input an annotation file (sequence, genome...) in gtf format in order to generate indexes that will be used in a 2nd step of the program.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
257 | Indexes are files which list all the coordinates of all categories (stop codon, 5'-UTR, CDS, intergenic...) and biotypes (protein coding genes, miRNA, tRNA, ...) encountered in the annotated sequence.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
258
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
259 .. class:: warningmark
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
260
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
261 Gtf File must be sorted.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
262
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
263 .. class:: infomark
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
264
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
265 Generation of indexes from an annotation file may be time consuming (i.e ~10min for the human genome). Thus, ALFA allows the user to submit directly indexes generated in previous runs.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
266
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
267 2. **Input 2: Reads**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
268
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
269 | ALFA requires as second input a single or a set of mapped reads file(s) in either bam or bedgraph format. These files are required to intersect the coordinates of the mapped reads with the associated categories and biotypes on the annotated sequence.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
270 | The strandness option determines which strand of the annotated sequence will be taken into account during this intersection.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
271
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
272 .. class:: warningmark
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
273
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
274 Bam or Bedgraph file(s) must be sorted.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
275
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
276 <!--
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
277 .. class:: warningmark
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
278
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
279 For oriented reads (either matching the forward strand or the reverse strand), 'forward' or 'reverse' strandness must be selected.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
280
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
281 .. class:: warningmark
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
282
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
283 For paired-end or non-oriented reads, 'unstranded' strandness must be selected.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
284 -->
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
285
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
286 3. **Output files**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
287
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
288 | The result of the intersection is a count file displaying the count of nucleotides in the reads for each genomic categories and biotypes. From this count file, plots of the raw and normalized distributions of the reads among these categories are generated.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
289 | In the output files section, the user can choose what kind of files he desires as ALFA output. Categories Count File and Plots are proposed by default.
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
290
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
291 .. class:: infomark
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
292
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
293 The user can also select the 'indexes' option as output. This option is interesting if you plan to run ALFA again with the same submitted annotation file. *See Nota Bene/Input 1: Annotation File for more information.*
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
294
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
295
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
296 - `How the plots look like`_
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
297
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
298 .. _How the plots look like: https://github.com/biocompibens/ALFA#plots
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
299
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
300 - `How they are generated`_
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
301
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
302 .. _How they are generated: https://github.com/biocompibens/ALFA#detailed-example
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
303
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
304 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
305
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
306 **ALFA Developpers**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
307
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
308 | Benoît Noël and Mathieu Bahin: *compbio team, Institut de Biologie de l'Ecole Normale Supérieure de Paris*
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
309
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
310
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
311 </help>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
312
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
313 <citations>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
314 <citation type="bibtex">@MISC{
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
315 author="Benoît Noël and Mathieu Bahin"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
316 title="ALFA: Annotation Landscape For Aligned reads"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
317 crossref="https://github.com/biocompibens/ALFA"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
318 institution="Institut de Biologie de l'Ecole Normale Supérieure de Paris"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
319 }
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
320 </citation>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
321 </citations>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
322 </tool>