annotate sequenza_wrapper.xml @ 39:31adf1afb841 draft default tip

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