annotate optitype.xml @ 4:111d2508ab15 draft

Uploaded
author jjohnson
date Mon, 07 Aug 2017 15:46:02 -0400
parents 4f78281c42ff
children 044f0a2e2a36
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
1 <tool id="optitype" name="OptiType" version="1.2.1">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
2 <description>HLA genotyping predictions from NGS data</description>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
3 <requirements>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
4 <requirement type="package" version="1.2.1">optitype</requirement>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
5 </requirements>
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
6 <stdio>
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
7 <exit_code range="1:" level="fatal" description="Error Running optitype" />
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
8 </stdio>
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
9 <command>
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
10 <![CDATA[
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
11 #set $fastqs = []
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
12 #if str( $fastq_input.fastq_input_selector ) == "paired":
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
13 ln -s "${fastq_input.fastq_input1}" reads_1.fastq
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
14 && ln -s "${fastq_input.fastq_input2}" reads_2.fastq
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
15 #set $fastqs = ['reads_1.fastq','reads_2.fastq']
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
16 #elif str( $fastq_input.fastq_input_selector ) == "paired_collection":
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
17 ln -s "${fastq_input.fastq_input1.forward}" reads_1.fastq
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
18 && ln -s "${fastq_input.fastq_input1.reverse}" reads_2.fastq
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
19 #set $fastqs = ['reads_1.fastq','reads_2.fastq']
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
20 #elif str( $fastq_input.fastq_input_selector ) == "single":
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
21 ln -s "${fastq_input.fastq_input1}" reads.fastq
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
22 #set $fastqs = ['reads.fastq']
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
23 #end if
1
bd817c1fdd63 Uploaded
jjohnson
parents: 0
diff changeset
24 && cp \$OPTITYPE_DIR/config.ini .
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
25 && sed "s/path_to_razers3/`which razers3`/" '$optitype_config' | sed "s/threads=16/threads=\$GALAXY_SLOTS/" > config.ini
1
bd817c1fdd63 Uploaded
jjohnson
parents: 0
diff changeset
26 && ln -s \$OPTITYPE_DIR/data data
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
27 #set $input_fq = ' '.join($fastqs)
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
28 && OptiTypePipeline.py
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
29 $read_type --input ${' '.join($fastqs)}
2
61fc10014a9e Uploaded
jjohnson
parents: 1
diff changeset
30 #if str($beta) != '':
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
31 --beta $beta
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
32 #end if
2
61fc10014a9e Uploaded
jjohnson
parents: 1
diff changeset
33 #if str($enumerations) != '':
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
34 --enumerate $enumerations
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
35 #end if
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
36 --config "`pwd`/config.ini"
1
bd817c1fdd63 Uploaded
jjohnson
parents: 0
diff changeset
37 --outdir $outdir
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
38 && cp $outdir/*/*_coverage_plot.pdf $coverage_plot
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
39 && cp $outdir/*/*_result.tsv $result
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
40 ]]>
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
41 </command>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
42 <configfiles>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
43 <configfile name="optitype_config"><![CDATA[
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
44 [mapping]
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
45
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
46 # Absolute path to RazerS3 binary, and number of threads to use for mapping
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
47
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
48 razers3=path_to_razers3
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
49 threads=16
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
50
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
51 [ilp]
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
52
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
53 # A Pyomo-supported ILP solver. The solver must be globally accessible in the
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
54 # environment OptiType is run, so make sure to include it in PATH.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
55 # Note: this is NOT a path to the solver binary, but a keyword argument for
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
56 # Pyomo. Examples: glpk, cplex, cbc.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
57
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
58 solver=$solver
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
59 threads=1
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
60
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
61 [behavior]
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
62
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
63 # tempdir=/path/to/tempdir # we may enable this setting later. Not used now.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
64
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
65 # Delete intermediate bam files produced by RazerS3 after OptiType finished
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
66 # loading them. If you plan to re-analyze your samples with different settings
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
67 # disabling this option can be a time-saver, as you'll be able to pass the bam
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
68 # files to OptiType directly as input and spare the expensive read mapping
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
69 # step.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
70
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
71 deletebam=true
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
72
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
73 # In paired-end mode one might want to use reads with just one mapped end (e.g.,
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
74 # the other end falls outside the reference region). This setting allows the
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
75 # user to keep them with an optionally reduced weight. A value of 0 means they
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
76 # are discarded for typing, 0.2 means single reads are "worth" 20% of paired
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
77 # reads, and a value of 1 means they are treated as valuable as properly mapped
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
78 # read pairs. Note: unpaired reads will be reported on the result coverage plots
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
79 # for completeness, regardless of this setting.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
80
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
81 unpaired_weight=$unpaired_weight
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
82
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
83 # We call a read pair discordant if its two ends best-map to two disjoint sets
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
84 # of alleles. Such reads can be either omitted or either of their ends treated
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
85 # as unpaired hits. Note: discordant read pairs are reported on the coverage
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
86 # plots as unpaired reads, regardless of this setting.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
87
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
88 use_discordant=$use_discordant
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
89 ]]></configfile>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
90 </configfiles>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
91 <inputs>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
92 <conditional name="fastq_input">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
93 <param name="fastq_input_selector" type="select" label="Single or Paired-end reads" help="Select between paired and single end data">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
94 <option value="paired">Paired</option>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
95 <option value="single">Single</option>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
96 <option value="paired_collection">Paired Collection</option>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
97 </param>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
98 <when value="paired">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
99 <param name="fastq_input1" type="data" format="fastqsanger" label="Select first set of reads" help="Specify dataset with forward reads"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
100 <param name="fastq_input2" type="data" format="fastqsanger" label="Select second set of reads" help="Specify dataset with reverse reads"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
101 </when>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
102 <when value="single">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
103 <param name="fastq_input1" type="data" format="fastqsanger" label="Select fastq dataset" help="Specify dataset with single reads"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
104 </when>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
105 <when value="paired_collection">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
106 <param name="fastq_input1" format="fastqsanger" type="data_collection" collection_type="paired" label="Select a paired collection" help="See help section for an explanation of dataset collections"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
107 </when>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
108 </conditional>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
109 <param name="read_type" type="select" label="Nucleotide Type" help="">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
110 <option value="--rna">RNA</option>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
111 <option value="--dna">DNA</option>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
112 </param>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
113 <param name="beta" type="float" value="" min="0.0" max="0.1" optional="true" label="homozygosity beta" help="The beta value for for homozygosity detection (Leave blank for default: 0.009)"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
114 <param name="enumerations" type="integer" value="" min="1" max="5" optional="true" label="Enumerations" help="The number of enumerations (Leave blank for default: 1)"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
115 <param name="solver" type="select" label="ILP solver" help="">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
116 <option value="glpk">glpk</option>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
117 <!--
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
118 <option value="cbc">cbc</option>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
119 -->
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
120 </param>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
121 <param name="unpaired_weight" type="float" value="0" min="0.0" max="1.0" label="unpaired_weight">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
122 <help><![CDATA[
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
123 In paired-end mode one might want to use reads with just one mapped end (e.g.,
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
124 the other end falls outside the reference region). This setting allows the
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
125 user to keep them with an optionally reduced weight. A value of 0 means they
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
126 are discarded for typing, 0.2 means single reads are "worth" 20% of paired
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
127 reads, and a value of 1 means they are treated as valuable as properly mapped
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
128 read pairs. Note: unpaired reads will be reported on the result coverage plots
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
129 for completeness, regardless of this setting. ]]>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
130 </help>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
131 </param>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
132 <param name="use_discordant" type="boolean" truevalue="true" falsevalue="false" checked="false" label="use_discordant">
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
133 <help><![CDATA[
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
134 We call a read pair discordant if its two ends best-map to two disjoint sets
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
135 of alleles. Such reads can be either omitted or either of their ends treated
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
136 as unpaired hits. Note: discordant read pairs are reported on the coverage
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
137 plots as unpaired reads, regardless of this setting. ]]>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
138 </help>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
139 </param>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
140 <param name="outdir" type="hidden" value="output_dir"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
141 </inputs>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
142 <outputs>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
143 <data format="pdf" name="coverage_plot" label="${tool.name} on ${on_string} coverage_plot.pdf"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
144 <data format="tabular" name="result" label="${tool.name} on ${on_string} result.tsv"/>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
145 </outputs>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
146 <tests>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
147 <test>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
148 </test>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
149 </tests>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
150 <help>
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
151 <![CDATA[
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
152 **OptiType**
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
153 ============
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
154
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
155 OptiType_ is a novel HLA genotyping algorithm based on integer linear programming, capable of producing accurate 4-digit HLA genotyping predictions from NGS data by simultaneously selecting all major and minor HLA Class I alleles.
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
156
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
157 **INPUTS**
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
158
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
159 RNA or DNA sequences in fastq format.
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
160
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
161 **OPTIONS**
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
162
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
163 --beta <BETA_VALUE> The beta value for for homozygosity detection (see cited paper).
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
164 Default: 0.009. Handle with care.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
165 --enumerate <ENUMERATIONS> Number of enumerations.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
166 OptiType will output the optimal solution and the top N-1 suboptimal solutions in the results.
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
167 Default: 1
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
168
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
169
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
170 **OUTPUTS**
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
171
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
172 result.tsv A TAB-separated file of HLA genotyping predictions:
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
173
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
174 ::
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
175
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
176 A1 A2 B1 B2 C1 C2 Reads Objective
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
177 0 A*31:01 A*68:01 B*40:01 B*51:01 C*15:02 C*03:04 132 128.43599999999998
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
178
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
179
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
180 coverage_plot.pdf Plots of coverage of HLA genotyping predictions
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
181
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
182 .. _OptiType: https://github.com/FRED-2/OptiType
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
183 ]]>
4
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
184 </help>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
185 <citations>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
186 <citation type="doi">10.1093/bioinformatics/btu548</citation>
111d2508ab15 Uploaded
jjohnson
parents: 3
diff changeset
187 </citations>
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
188 </tool>