annotate optitype.xml @ 3:4f78281c42ff draft

Uploaded
author jjohnson
date Mon, 23 Nov 2015 09:56:42 -0500
parents 61fc10014a9e
children 111d2508ab15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
1 <tool id="optitype" name="OptiType" version="1.0.0">
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
2 <description>HLA genotyping predictions from NGS data</description>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
3 <requirements>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
4 <requirement type="package" version="1.8.12">hdf5</requirement>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
5 <requirement type="package" version="3.4.0">razers3</requirement>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
6 <requirement type="package" version="1.0">optitype</requirement>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
7 <requirement type="package" version="2.9.5">cbc</requirement>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
8 </requirements>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
9 <stdio>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
10 <exit_code range="1:" level="fatal" description="Error Running optitype" />
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
11 </stdio>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
12 <command>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
13 <![CDATA[
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
14 #set $fastqs = []
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
15 #if str( $fastq_input.fastq_input_selector ) == "paired":
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
16 ln -s "${fastq_input.fastq_input1}" reads_1.fastq
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
17 && ln -s "${fastq_input.fastq_input2}" reads_2.fastq
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
18 #set $fastqs = ['reads_1.fastq','reads_2.fastq']
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
19 #elif str( $fastq_input.fastq_input_selector ) == "paired_collection":
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
20 ln -s "${fastq_input.fastq_input1.forward}" reads_1.fastq
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
21 && ln -s "${fastq_input.fastq_input1.reverse}" reads_2.fastq
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
22 #set $fastqs = ['reads_1.fastq','reads_2.fastq']
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
23 #elif str( $fastq_input.fastq_input_selector ) == "single":
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
24 ln -s "${fastq_input.fastq_input1}" reads.fastq
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
25 #set $fastqs = ['reads.fastq']
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
26 #end if
1
bd817c1fdd63 Uploaded
jjohnson
parents: 0
diff changeset
27 && cp \$OPTITYPE_DIR/config.ini .
bd817c1fdd63 Uploaded
jjohnson
parents: 0
diff changeset
28 && ln -s \$OPTITYPE_DIR/data data
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
29 #set $input_fq = ' '.join($fastqs)
1
bd817c1fdd63 Uploaded
jjohnson
parents: 0
diff changeset
30 && python \$OPTITYPE_DIR/OptiTypePipeline.py
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
31 $read_type --input ${' '.join($fastqs)}
2
61fc10014a9e Uploaded
jjohnson
parents: 1
diff changeset
32 #if str($beta) != '':
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
33 --beta $beta
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
34 #end if
2
61fc10014a9e Uploaded
jjohnson
parents: 1
diff changeset
35 #if str($enumerations) != '':
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
36 --enumerate $enumerations
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
37 #end if
1
bd817c1fdd63 Uploaded
jjohnson
parents: 0
diff changeset
38 --outdir $outdir
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
39 && cp $outdir/*/*_coverage_plot.pdf $coverage_plot
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
40 && cp $outdir/*/*_result.tsv $result
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
41 ]]>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
42 </command>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
43 <inputs>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
44 <conditional name="fastq_input">
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
45 <param name="fastq_input_selector" type="select" label="Single or Paired-end reads" help="Select between paired and single end data">
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
46 <option value="paired">Paired</option>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
47 <option value="single">Single</option>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
48 <option value="paired_collection">Paired Collection</option>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
49 </param>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
50 <when value="paired">
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
51 <param name="fastq_input1" type="data" format="fastqsanger" label="Select first set of reads" help="Specify dataset with forward reads"/>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
52 <param name="fastq_input2" type="data" format="fastqsanger" label="Select second set of reads" help="Specify dataset with reverse reads"/>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
53 </when>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
54 <when value="single">
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
55 <param name="fastq_input1" type="data" format="fastqsanger" label="Select fastq dataset" help="Specify dataset with single reads"/>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
56 </when>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
57 <when value="paired_collection">
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
58 <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"/>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
59 </when>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
60 </conditional>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
61 <param name="read_type" type="select" label="Nucleotide Type" help="">
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
62 <option value="--rna">RNA</option>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
63 <option value="--dna">DNA</option>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
64 </param>
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
65 <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)"/>
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
66 <param name="enumerations" type="integer" value="" min="1" max="5" optional="true" label="Enumerations" help="The number of enumerations (Leave blank for default: 1)"/>
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
67 <param name="outdir" type="hidden" value="output_dir"/>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
68 </inputs>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
69 <outputs>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
70 <data format="pdf" name="coverage_plot" label="${tool.name} on ${on_string} coverage_plot.pdf"/>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
71 <data format="tabular" name="result" label="${tool.name} on ${on_string} result.tsv"/>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
72 </outputs>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
73 <tests>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
74 <test>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
75 </test>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
76 </tests>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
77 <help>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
78 <![CDATA[
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
79 **OptiType**
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
80 ============
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
81
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
82 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
83
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
84 **INPUTS**
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
85
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
86 RNA or DNA sequences in fastq format.
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
87
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
88 **OPTIONS**
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
89
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
90 --beta <BETA_VALUE> The beta value for for homozygosity detection (see cited paper).
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
91 Default: 0.009. Handle with care.
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
92 --enumerate <ENUMERATIONS> Number of enumerations.
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
93 OptiType will output the optimal solution and the top N-1 suboptimal solutions in the results.
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
94 Default: 1
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
95
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
96
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
97 **OUTPUTS**
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
98
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
99 result.tsv A TAB-separated file of HLA genotyping predictions:
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
100
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
101 ::
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
102
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
103 A1 A2 B1 B2 C1 C2 Reads Objective
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
104 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
105
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
106
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
107 coverage_plot.pdf Plots of coverage of HLA genotyping predictions
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
108
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
109 .. _OptiType: https://github.com/FRED-2/OptiType
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
110 ]]>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
111 </help>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
112 <citations>
3
4f78281c42ff Uploaded
jjohnson
parents: 2
diff changeset
113 <citation type="doi">10.1093/bioinformatics/btu548</citation>
0
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
114 </citations>
887bc9c92c05 Uploaded
jjohnson
parents:
diff changeset
115 </tool>