annotate sequenza_wrapper.xml @ 11:3b7cb5a0ebf8 draft

Uploaded
author jbrayet
date Tue, 18 Aug 2015 09:05:33 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
1 <!--Sequenza - developed by Jocelyn Brayet <jocelyn.brayet@curie.fr>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
2 Copyright (C) 2015 Institut Curie
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
3
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
4 This program is free software: you can redistribute it and/or modify
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
6 the Free Software Foundation, either version 3 of the License, or
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
7 (at your option) any later version.
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
8
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
12 GNU General Public License for more details.
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
13
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>.-->
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
16 <tool id="sequenza_tool" name="Sequenza" version="1.2">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
17 <description>allele-specific copy number and mutation profiles</description>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
18 <requirements>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
19 <requirement type="package" version="2.7">python</requirement>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
20 <requirement type="package" version="2.1.1">sequenza</requirement>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
21 </requirements>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
22 <command interpreter="python">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
23 sequenza_wrapper.py -name $sampleName -outGalaxy $HTMLFile -format $fileFormat.format -estimation $usePersonalEstimation.estimation -gcContent $gc_content_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
24 #if $fileFormat.format == "BAM":
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
25 #if $fileFormat.reference_source.reference_source_selector=="cached":
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
26 -selector $fileFormat.reference_source.reference_source_selector
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
27 -normal $fileFormat.reference_source.normal_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
28 -tumor $fileFormat.reference_source.tumor_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
29 -ref_file $fileFormat.reference_source.ref_file.fields.path
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
30 -samtools_options '
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
31 $fileFormat.skip_anomalous_read_pairs
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
32 $fileFormat.disable_probabilistic_realignment
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
33 -d "$fileFormat.max_reads_per_bam"
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
34 -q "$fileFormat.minimum_mapping_quality"
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
35 -Q "$fileFormat.minimum_base_quality"
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
36 '
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
37 #else:
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
38 -selector $fileFormat.reference_source.reference_source_selector
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
39 -normal $fileFormat.reference_source.normal_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
40 -tumor $fileFormat.reference_source.tumor_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
41 -ref_file $fileFormat.reference_source.ref_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
42 #end if
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
43 #else:
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
44 -normal $fileFormat.normal_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
45 -tumor $fileFormat.tumor_file
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
46 #end if
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
47 #if $usePersonalEstimation.estimation == "yes":
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
48 -cellularity $usePersonalEstimation.cellularity
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
49 -ploidy $usePersonalEstimation.ploidy
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
50 #end if
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
51 </command>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
52 <inputs>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
53 <param name="sampleName" type="text" value="sample" size="30" label="Sample name">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
54 <sanitizer invalid_char="">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
55 <valid initial="string.letters,string.digits"><add value="_"/></valid>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
56 </sanitizer>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
57 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
58 <conditional name="fileFormat">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
59 <param name="format" type="select" label="File format" >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
60 <option value="BAM" selected="true">BAM</option>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
61 <option value="pileup" >Pileup</option>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
62 <option value="pileup_gz" >Pileup.gz</option>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
63 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
64 <when value="BAM">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
65 <conditional name="reference_source">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
66 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
67 <option value="cached">Locally cached</option>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
68 <option value="history">History</option>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
69 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
70 <when value="cached">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
71 <param name="normal_file" type="data" format="bam" label="Normal BAM file" >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
72 <validator type="unspecified_build" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
73 <validator type="dataset_metadata_in_data_table" table_name="sam_fa_indexes" metadata_name="dbkey" metadata_column="value" message="Sequences are not currently available for the specified build." />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
74 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
75 <param name="tumor_file" type="data" format="bam" label="Tumor BAM file" >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
76 <validator type="unspecified_build" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
77 <validator type="dataset_metadata_in_data_table" table_name="sam_fa_indexes" metadata_name="dbkey" metadata_column="value" message="Sequences are not currently available for the specified build." />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
78 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
79 <param name="ref_file" type="select" label="Using reference genome">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
80 <options from_data_table="sam_fa_indexes">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
81 </options>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
82 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
83 </when>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
84 <when value="history">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
85 <param name="normal_file" type="data" format="bam" label="Normal BAM file" >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
86 <validator type="metadata" check="bam_index" message="Metadata missing, click the pencil icon in the history item and use the auto-detect feature to correct this issue."/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
87 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
88 <param name="tumor_file" type="data" format="bam" label="Tumor BAM file" >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
89 <validator type="metadata" check="bam_index" message="Metadata missing, click the pencil icon in the history item and use the auto-detect feature to correct this issue."/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
90 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
91 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
92 </when>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
93 </conditional>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
94 <param name="skip_anomalous_read_pairs" type="boolean" truevalue="-A" falsevalue="" checked="False" label="Do not skip anomalous read pairs in variant calling" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
95 <param name="disable_probabilistic_realignment" type="boolean" truevalue="-B" falsevalue="" checked="False" label="Disable probabilistic realignment for the computation of base alignment quality (BAQ)" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
96 <param name="max_reads_per_bam" type="integer" value="100000" label="Max reads per BAM" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
97 <param name="minimum_mapping_quality" type="integer" value="20" label="Minimum mapping quality for an alignment to be used" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
98 <param name="minimum_base_quality" type="integer" value="13" label="Minimum base quality for a base to be considered" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
99 </when>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
100 <when value="pileup">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
101 <param name="normal_file" type="data" format="pileup" label="Normal pileup file" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
102 <param name="tumor_file" type="data" format="pileup" label="Tumor pileup file" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
103 </when>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
104 <when value="pileup_gz">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
105 <param name="normal_file" type="data" format="pileup.gz" label="Normal pileup.gz file" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
106 <param name="tumor_file" type="data" format="pileup.gz" label="Tumor pileup.gz file" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
107 </when>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
108 </conditional >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
109 <param name="gc_content_file" type="data" format="txt" label="GC content file" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
110 <conditional name="usePersonalEstimation">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
111 <param name="estimation" type="select" label="Do you want to use personal cellularity and ploidy? Otherwise Sequenza estimates cellularity and ploidy" >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
112 <option value="no" selected="true">No</option>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
113 <option value="yes" >Yes</option>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
114 </param>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
115 <when value="no" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
116 <when value="yes">
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
117 <param name="cellularity" type="integer" value="30" min="0" max="100" label="Cellularity used (%)" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
118 <param name="ploidy" type="integer" value="2" label="Ploidy used" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
119 </when>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
120 </conditional >
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
121 </inputs>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
122 <outputs>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
123 <data format="html" name="HTMLFile" label="HTML output - Sequenza results" />
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
124 </outputs>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
125 <tests>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
126 <test>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
127 <param name="sampleName" value="test_curie"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
128 <param name="fileFormat" value="pileup"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
129 <param name="normal_file" value="constit_2.pileup"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
130 <param name="tumor_file" value="tumor_2.pileup"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
131 <param name="gc_content_file" value="hg19_chro1.gc50Base.txt"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
132 <param name="estimation" value="yes"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
133 <param name="cellularity" value="30"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
134 <param name="ploidy" value="2"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
135 <output name="HTMLFile" file="test_sequenza_1.dat" ftype="html"/>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
136 </test>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
137 </tests>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
138 <help>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
139
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
140 **What it does**
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
141
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
142 Tools to analyze genomic sequencing data from paired normal-tumor samples, including cellularity and ploidy estimation; mutation and copy number (allele-specific and total copy number) detection, quantification and visualization.
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
143
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
144 </help>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
145 <citations>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
146 <citation type="bibtex">@article{Favero01012015,
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
147 author = {Favero, F. and Joshi, T. and Marquard, A. M. and Birkbak, N. J. and Krzystanek, M. and Li, Q. and Szallasi, Z. and Eklund, A. C.},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
148 title = {Sequenza: allele-specific copy number and mutation profiles from tumor sequencing data},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
149 volume = {26},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
150 number = {1},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
151 pages = {64-70},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
152 year = {2015},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
153 doi = {10.1093/annonc/mdu479},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
154 URL = {http://annonc.oxfordjournals.org/content/26/1/64.abstract},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
155 eprint = {http://annonc.oxfordjournals.org/content/26/1/64.full.pdf+html},
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
156 journal = {Annals of Oncology}
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
157 }</citation>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
158 </citations>
3b7cb5a0ebf8 Uploaded
jbrayet
parents:
diff changeset
159 </tool>