annotate ALFA/alfa_wrapper.xml @ 25:37fce32b0298 draft

Uploaded
author charles-bernard
date Mon, 31 Oct 2016 14:06:18 -0400
parents 887c6cb328e9
children c3f91012ac19
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
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
11 <command interpreter="python">
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
12 <![CDATA[
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
13 ALFA_wrapper.py
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
14
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
15 --project_name "${projectName}"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
16
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
17 ##__INPUT 1__##
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
18 #if str ( $annotation.annotationSource['annotationSourceSelection'] ) == "index"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
19 --index $annotation.annotationSource['strandedIndex'] $annotation.annotationSource['unstrandedIndex']
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
20 #else if str ( $annotation.annotationSource['annotationSourceSelection'] ) == "built_in_index"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
21 --bi_index $annotation.annotationSource.built_in_index_prefix.fields.prefix
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
22 #else
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
23 --annotation $annotation.annotationSource['annotationFile']
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
24 #end if
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
25
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
26 ##__INPUT 2__##
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
27 --reads_format $reads.readsType['readsTypeSelection']
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
28 --reads
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
29 #for $i, $r in enumerate ( $reads.readsType['readsList'] )
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
30 __fname__$r.readsFile
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
31 __label__$r.readsLabel
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
32 #end for
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
33 --strandness $reads['strandness']
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
34
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
35 ##__OUTPUT FILES__##
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
36 #if str ( $outputFiles['plot'] ) == "True"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
37 #if str ( $outputOptions['plotFormat'] ) == "pdf"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
38 --output_pdf $outputPdf
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
39 #else if str ( $outputOptions['plotFormat'] ) == "png"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
40 --output_png $outputCategoriesPng $outputBiotypesPng
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
41 #else
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
42 --output_svg $outputCategoriesSvg $outputBiotypesSvg
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
43 #end if
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
44 #end if
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
45 #if str ( $outputFiles['countFile'] ) == "True"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
46 --output_count $outputCountFile
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
47 #end if
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
48 #if str ( $outputFiles['index'] ) == "True"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
49 --output_index $outputStrandedIndex $outputUnstrandedIndex
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
50 #end if
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
51
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
52 ##__OUTPUT OPTIONS__##
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
53 --categories_depth $outputOptions['categoriesDepth']
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
54 #if str ( $outputFiles['plot'] ) == "True"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
55 --plot_format $outputOptions['plotFormat']
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
56 #if str ( $outputOptions.plotThreshold['plotThresholdChoice'] ) == "True"
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
57 --threshold $outputOptions.plotThreshold.yMin $outputOptions.plotThreshold.yMax
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
58 #end if
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
59 #end if
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
60
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
61 --log_report $logReport
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
62 --tool_dir $__tool_directory__
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
63 ]]>
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
64 </command>
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
65 <inputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
66 <param name="projectName" value="ALFA" type="text" size="20" label="Project Name">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
67 <validator type="empty_field" message="Please, specify a name for your project."/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
68 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
69
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
70 <section name="annotation" title="INPUT 1: Annotation File (GTF format)" expanded="True">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
71 <conditional name="annotationSource">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
72 <param name="annotationSourceSelection" type="select" label="Select the source of your annotated sequence/genome">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
73 <option value="personal_gtf" selected="true">Personal annotation file (GTF format)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
74 <option value="index">Stranded and Unstranded Indexes previously generated by ALFA (Index format)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
75 <option value="built_in_index">Built-in indexes among a list of referenced genome (Index format)</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
76 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
77 <when value="personal_gtf">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
78 <param name="annotationFile" type="data" format="Gff, Gtf" label="Select your personal annotation file (GTF format)">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
79 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
80 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
81 <when value="index">
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
82 <param name="strandedIndex" type="data" format="index" label="Select your ALFA Stranded index file (index format)"/>
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
83 <param name="unstrandedIndex" type="data" format="index" label="Select your ALFA Unstranded index file (index format)"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
84 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
85 <when value="built_in_index">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
86 <param name="built_in_index_prefix" type="select" label="Select Genome">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
87 <options from_data_table="alfa_indexes">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
88 <validator type="no_options" message="No indexes are available for the selected input dataset" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
89 </options>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
90 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
91 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
92 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
93 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
94
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
95 <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
96 <conditional name="readsType">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
97 <param name="readsTypeSelection" type="select" label="Select the format of the reads file(s)">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
98 <option value="bam" selected="true">BAM</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
99 <option value="bedgraph">BEDGRAPH</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
100 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
101 <when value="bam">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
102 <repeat name="readsList" title="Reads File" min="1" >
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
103 <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
104 <param name="readsLabel" type="text" size="20" value="" label="Label of the reads" optional="True"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
105 </repeat>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
106 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
107 <when value="bedgraph">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
108 <repeat name="readsList" title="Reads File" min="1">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
109 <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
110 <param name="readsLabel" type="text" size="20" value="" label="Label of the reads" optional="True"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
111 </repeat>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
112 </when>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
113 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
114 <param name="strandness" type="select" label="Select the strandness of your mapped reads dataset">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
115 <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
116 <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
117 <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
118 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
119 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
120
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
121 <section name="outputFiles" title="OUTPUT FILES: Choose the output files" expanded="False">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
122 <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
123 <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
124 <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
125 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
126
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
127 <section name="outputOptions" title="ADVANCED SETTINGS" expanded="False">
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
128 <param name="categoriesDepth" type="select" label="Categories to Display">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
129 <option value="1">gene | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
130 <option value="2">exon | intron | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
131 <option value="3" selected="true">5’-UTR | CDS | 3’-UTR | intron | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
132 <option value="4">5’-UTR | start_codon | CDS | stop_codon | 3’-UTR | intron | intergenic</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
133 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
134 <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
135 <option value="pdf" selected="true">pdf</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
136 <option value="svg">svg</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
137 <option value="png">png</option>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
138 </param>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
139 <conditional name="plotThreshold">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
140 <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
141 <when value="True">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
142 <param name="yMin" type="float" value="-2.0" label="y min"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
143 <param name="yMax" type="float" value="2.0" label="y max"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
144 </when>
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
145 <when value="False"></when>
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
146 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
147 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
148 </inputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
149
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
150 <outputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
151 <data name="logReport" format="txt" label="${projectName}-Log Report"/>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
152 <data name="outputPdf" format="pdf" label="${projectName}-BioFeatures Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
153 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'pdf'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
154 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
155 <data name="outputCategoriesPng" format="png" label="${projectName}-Categories Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
156 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'png'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
157 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
158 <data name="outputBiotypesPng" format="png" label="${projectName}-Biotypes Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
159 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'png'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
160 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
161 <data name="outputCategoriesSvg" format="svg" label="${projectName}-Categories Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
162 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'svg'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
163 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
164 <data name="outputBiotypesSvg" format="svg" label="${projectName}-Biotypes Distribution">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
165 <filter>outputFiles['plot'] is True and outputOptions['plotFormat'] == 'svg'</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
166 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
167 <data name="outputCountFile" format="txt" label="${projectName}-Categories Count">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
168 <filter>outputFiles['countFile'] is True</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
169 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
170 <data name="outputStrandedIndex" format="txt" label="${projectName}-Stranded Index">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
171 <filter>outputFiles['index'] is True</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
172 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
173 <data name="outputUnstrandedIndex" format="txt" label="${projectName}-Unstranded Index">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
174 <filter>outputFiles['index'] is True</filter>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
175 </data>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
176 </outputs>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
177
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
178 <tests>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
179 <test>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
180 <param name="alfa_toy" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
181 <section name="annotation">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
182 <conditional name="annotationSource">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
183 <param name="annotationSourceSelection" value="personal_gtf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
184 <param name="annotationFile" value="alfa_toy.gtf" ftype="gtf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
185 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
186 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
187 <section name="reads">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
188 <conditional name="readsType">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
189 <param name="readsTypeSelection" value="bam" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
190 <repeat name="readsList">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
191 <param name="readsFile" value="alfa_toy.bam" ftype="bam" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
192 <param name="readsLabel" value="alfa_toy" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
193 </repeat>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
194 <param name="strandness" value="unstranded" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
195 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
196 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
197 <section name="outputFiles">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
198 <param name="plot" value="True" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
199 <param name="countFile" value="True" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
200 <param name="index" value="True" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
201 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
202 <section name="outputOptions">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
203 <param name="categoriesDepth" value="3" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
204 <param name="plotFormat" value="pdf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
205 <conditional name="plotThreshold">
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
206 <param name="plotThresholdChoice" value="False" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
207 </conditional>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
208 </section>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
209 <output name="outputPdf" file="alfa_toy-Biofeatures Distribution.pdf" ftype="pdf" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
210 <output name="outputCountFile" file="alfa_toy.categories_count" ftype="txt" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
211 <output name="outputStrandedIndex" file="alfa_toy.stranded.index" ftype="txt" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
212 <output name="outputUnstrandedIndex" file="alfa_toy.unstranded.index" ftype="txt" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
213 <assert_stdout>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
214 <has_text text="### End of the program" />
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
215 </assert_stdout>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
216 </test>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
217 </tests>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
218
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
219 <help>
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
220 <![CDATA[
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
221 **What it does**
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
222
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
223
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
224 | ALFA provides a global overview of features distribution composing New Generation Sequencing dataset(s).
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
225 |
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
226 | 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
227
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
228 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
229
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
230 **ALFA acronym**
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
231
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
232 - Annotation.Landscape.For.Aligned reads
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
233
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
234 ----
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
235
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
236 **Official documentation of the tool**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
237
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
238
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
239 - https://github.com/biocompibens/ALFA
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
240
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
241 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
242
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
243 **Detailed example**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
244
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
245 - https://github.com/biocompibens/ALFA#detailed-example
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
246
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
247 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
248
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
249 **Nota Bene**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
250
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
251 * **Input 1: Annotation File**
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
252
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
253
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
254 | ALFA requires as first input an annotation file (sequence, genome...) in gtf format in order to generate alfa indexes needed in a second round of the program.
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
255 | Indexes are files which list all the coordinates of the categories (stop codon, 5'-UTR, CDS, intergenic...) and biotypes (protein coding genes, miRNA, tRNA, ...) encountered in the annotated sequence.
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
256 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
257
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
258 .. class:: warningmark
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
259
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
260 | Gtf File must be sorted.
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
261 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
262
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
263 .. class:: infomark
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
264
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
265 | Generation of indexes from an annotation file might be time consuming (i.e ~10min for the human genome). Thus, ALFA allows the user to submit directly indexes generated in previous runs.
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
266 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
267
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
268 .. class:: infomark
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
269
24
887c6cb328e9 Uploaded
charles-bernard
parents: 22
diff changeset
270 | ALFA also allows to use built-in indexes to save even more computational time. In order to generate easily these built-in indexes, install the data manager tool `data_manager_build_alfa_indexes`_ available on the toolshed.
887c6cb328e9 Uploaded
charles-bernard
parents: 22
diff changeset
271
887c6cb328e9 Uploaded
charles-bernard
parents: 22
diff changeset
272 .. _data_manager_build_alfa_indexes: https://toolshed.g2.bx.psu.edu/view/charles-bernard/data_manager_build_alfa_indexes
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
273
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
274 * **Input 2: Reads**
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
275
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
276 | ALFA requires as second input a single or a set of mapped reads file(s) in either bam or bedgraph format. The coordinates of the mapped reads will be intersected with the according categories and biotypes mentioned in the indexes.
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
277 | The strandness option determines which strand of the annotated sequence will be taken into account during this intersection.
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
278 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
279
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
280 .. class:: warningmark
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
281
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
282 | Bam or Bedgraph file(s) must be sorted.
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
283 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
284
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
285 .. class:: warningmark
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
286
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
287 | Chromosome names in reads and in annotation file (gtf or indexes) must be the same for the intersection to occur
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
288 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
289
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
290 * **Output files**
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
291
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
292 | 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
293 | 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.
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
294 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
295
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
296 .. class:: infomark
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
297
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
298 | 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.*
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
299 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
300
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
301 - `How the plots look like`_
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
302
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
303 .. _How the plots look like: https://github.com/biocompibens/ALFA#plots
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
304
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
305 |
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
306
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
307 - `How they are generated`_
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
308
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
309 .. _How they are generated: https://github.com/biocompibens/ALFA#detailed-example
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
310
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
311 ----
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
312
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
313 **ALFA Developpers**
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
314
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
315 | 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
316
22
1714165f5df0 Uploaded
charles-bernard
parents: 20
diff changeset
317 ]]>
18
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
318 </help>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
319
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
320 <citations>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
321 <citation type="bibtex">@MISC{
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
322 author="Benoît Noël and Mathieu Bahin"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
323 title="ALFA: Annotation Landscape For Aligned reads"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
324 crossref="https://github.com/biocompibens/ALFA"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
325 institution="Institut de Biologie de l'Ecole Normale Supérieure de Paris"
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
326 }
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
327 </citation>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
328 </citations>
a1e2ab10b317 Uploaded
charles-bernard
parents:
diff changeset
329 </tool>