annotate exomedepth.xml @ 3:88b89f435f6a draft

Uploaded
author crs4
date Tue, 05 Jun 2018 18:58:08 -0400
parents
children a0a30c52978a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
88b89f435f6a Uploaded
crs4
parents:
diff changeset
1 <tool id="exomedepth" name="ExomeDepth" version="1.0.0">
88b89f435f6a Uploaded
crs4
parents:
diff changeset
2 <description>cnv caller</description>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
3 <requirements>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
4 <requirement type="package" version="1.1.10">r-exomedepth</requirement>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
5 </requirements>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
6 <command interpreter="Rscript">
88b89f435f6a Uploaded
crs4
parents:
diff changeset
7 exomedepth.R $args_file
88b89f435f6a Uploaded
crs4
parents:
diff changeset
8 </command>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
9 <inputs>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
10 <param format="bed" name="targetFile" type="data" label="Target regions (BED)">
88b89f435f6a Uploaded
crs4
parents:
diff changeset
11 <validator type="unspecified_build" />
88b89f435f6a Uploaded
crs4
parents:
diff changeset
12 </param>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
13 <param name="test_vs_ref" type="boolean" truevalue="TRUE" falsevalue="FALSE" checked="false" label="Call CNVs using 1st sample as test" help="If checked, the tool will call CNVs in the first sample vs all the others. If unchecked, an all vs all CNV call will be performed" />
88b89f435f6a Uploaded
crs4
parents:
diff changeset
14 <repeat name="inputs" title="BAM" min="2" help="Need to add more files? Use controls below.">
88b89f435f6a Uploaded
crs4
parents:
diff changeset
15 <param format="bam" name="input" type="data" label="BAM file">
88b89f435f6a Uploaded
crs4
parents:
diff changeset
16 <options>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
17 <filter type="data_meta" ref="targetFile" key="dbkey"/>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
18 </options>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
19 </param>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
20 <param name="label" type="text" size="30" value="" label="Label" help="Label to use in the output. If not given, the dataset name will be used instead">
88b89f435f6a Uploaded
crs4
parents:
diff changeset
21 <validator type="regex" message="Spaces are not allowed">^\S*$</validator>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
22 </param>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
23 </repeat>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
24 <param name="transition_probability" size="10" type="float" value="0.0001" label="Transition probability" help="Transition probability of the hidden Markov Chain from the normal copy number state to either a deletion or a duplication. The default value (0.0001) expects approximately 20 CNVs genome-wide" />
88b89f435f6a Uploaded
crs4
parents:
diff changeset
25 </inputs>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
26
88b89f435f6a Uploaded
crs4
parents:
diff changeset
27 <configfiles>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
28 <configfile name="args_file">target=$targetFile
88b89f435f6a Uploaded
crs4
parents:
diff changeset
29 test_vs_ref=$test_vs_ref
88b89f435f6a Uploaded
crs4
parents:
diff changeset
30 #for $i in $inputs
88b89f435f6a Uploaded
crs4
parents:
diff changeset
31 bam=${i.input}
88b89f435f6a Uploaded
crs4
parents:
diff changeset
32 bam_bai=${i.input.metadata.bam_index}
88b89f435f6a Uploaded
crs4
parents:
diff changeset
33 #if str($i.label.value) != "":
88b89f435f6a Uploaded
crs4
parents:
diff changeset
34 bam_label=${$i.label.value}
88b89f435f6a Uploaded
crs4
parents:
diff changeset
35 #else
88b89f435f6a Uploaded
crs4
parents:
diff changeset
36 bam_label=${i.input.dataset.name}
88b89f435f6a Uploaded
crs4
parents:
diff changeset
37 #end if
88b89f435f6a Uploaded
crs4
parents:
diff changeset
38 #end for
88b89f435f6a Uploaded
crs4
parents:
diff changeset
39 trans_prob=$transition_probability
88b89f435f6a Uploaded
crs4
parents:
diff changeset
40 output=$output
88b89f435f6a Uploaded
crs4
parents:
diff changeset
41 </configfile>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
42 </configfiles>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
43 <outputs>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
44 <data format="bed" name="output" label="${tool.name} on ${on_string}" />
88b89f435f6a Uploaded
crs4
parents:
diff changeset
45 </outputs>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
46 <help>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
47
88b89f435f6a Uploaded
crs4
parents:
diff changeset
48 .. class:: warningmark
88b89f435f6a Uploaded
crs4
parents:
diff changeset
49
88b89f435f6a Uploaded
crs4
parents:
diff changeset
50 **Warning about counts for chromosome X**
88b89f435f6a Uploaded
crs4
parents:
diff changeset
51
88b89f435f6a Uploaded
crs4
parents:
diff changeset
52 Calling CNVs on the X chromosome can create issues if the exome sample of interest and the reference exome
88b89f435f6a Uploaded
crs4
parents:
diff changeset
53 samples it is being compared to are not gender matched.
88b89f435f6a Uploaded
crs4
parents:
diff changeset
54 Make sure that the genders are matched properly (i.e. do not use male as a reference for female
88b89f435f6a Uploaded
crs4
parents:
diff changeset
55 samples and vice versa).
88b89f435f6a Uploaded
crs4
parents:
diff changeset
56
88b89f435f6a Uploaded
crs4
parents:
diff changeset
57 **What it does**
88b89f435f6a Uploaded
crs4
parents:
diff changeset
58
88b89f435f6a Uploaded
crs4
parents:
diff changeset
59 This tool uses ExomeDepth to call copy number variants (CNVs) from targeted sequence data.
88b89f435f6a Uploaded
crs4
parents:
diff changeset
60
88b89f435f6a Uploaded
crs4
parents:
diff changeset
61 **Output format**
88b89f435f6a Uploaded
crs4
parents:
diff changeset
62
88b89f435f6a Uploaded
crs4
parents:
diff changeset
63 =========== ========================
88b89f435f6a Uploaded
crs4
parents:
diff changeset
64 Column Description
88b89f435f6a Uploaded
crs4
parents:
diff changeset
65 ----------- ------------------------
88b89f435f6a Uploaded
crs4
parents:
diff changeset
66 chr Chromosome
88b89f435f6a Uploaded
crs4
parents:
diff changeset
67 start Start of CNV region
88b89f435f6a Uploaded
crs4
parents:
diff changeset
68 end End of CNV region
88b89f435f6a Uploaded
crs4
parents:
diff changeset
69 type CNV type (deletion, duplication)
88b89f435f6a Uploaded
crs4
parents:
diff changeset
70 sample Name of the sample with CNV
88b89f435f6a Uploaded
crs4
parents:
diff changeset
71 corr Correlation between reference and test counts. To get meaningful result, this correlation should really be above 0.97. If this is not the case, consider the output of ExomeDepth as less reliable (i.e. most likely a high false positive rate)
88b89f435f6a Uploaded
crs4
parents:
diff changeset
72 nexons Number of target regions covered by the CNV
88b89f435f6a Uploaded
crs4
parents:
diff changeset
73 BF Bayes factor. It quantifies the statistical support for each CNV. It is in fact the log10 of the likelihood ratio of data for the CNV call divided by the null (normal copy number). The higher that number, the more confident one can be about the presence of a CNV. While it is difficult to give an ideal threshold, and for short exons the Bayes Factor are bound to be unconvincing, the most obvious large calls should be easily flagged by ranking them according to this quantity
88b89f435f6a Uploaded
crs4
parents:
diff changeset
74 reads.ratio Observed/expected reads ratio
88b89f435f6a Uploaded
crs4
parents:
diff changeset
75 =========== ========================
88b89f435f6a Uploaded
crs4
parents:
diff changeset
76
88b89f435f6a Uploaded
crs4
parents:
diff changeset
77
88b89f435f6a Uploaded
crs4
parents:
diff changeset
78 **What ExomeDepth does and does not do**
88b89f435f6a Uploaded
crs4
parents:
diff changeset
79
88b89f435f6a Uploaded
crs4
parents:
diff changeset
80 ExomeDepth uses read depth data to call CNVs from exome sequencing experiments. A key idea is that the test
88b89f435f6a Uploaded
crs4
parents:
diff changeset
81 exome should be compared to a matched aggregate reference set. This aggregate reference set should combine
88b89f435f6a Uploaded
crs4
parents:
diff changeset
82 exomes from the same batch and it should also be optimized for each exome. It will certainly differ from one exome
88b89f435f6a Uploaded
crs4
parents:
diff changeset
83 to the next.
88b89f435f6a Uploaded
crs4
parents:
diff changeset
84
88b89f435f6a Uploaded
crs4
parents:
diff changeset
85 Importantly, ExomeDepth assumes that the CNV of interest is absent from the aggregate reference set. Hence
88b89f435f6a Uploaded
crs4
parents:
diff changeset
86 related individuals should be excluded from the aggregate reference. It also means that ExomeDepth can miss
88b89f435f6a Uploaded
crs4
parents:
diff changeset
87 common CNVs, if the call is also present in the aggregate reference. ExomeDepth is really suited to detect rare
88b89f435f6a Uploaded
crs4
parents:
diff changeset
88 CNV calls (typically for rare Mendelian disorder analysis).
88b89f435f6a Uploaded
crs4
parents:
diff changeset
89
88b89f435f6a Uploaded
crs4
parents:
diff changeset
90 The ideas used in this package are of course not specific to exome sequencing and could be applied to other
88b89f435f6a Uploaded
crs4
parents:
diff changeset
91 targeted sequencing datasets, as long as they contain a sufficiently large number of exons to estimate the parameters
88b89f435f6a Uploaded
crs4
parents:
diff changeset
92 (at least 20 genes, say, but probably more would be useful). Also note that PCR based enrichment studies are often
88b89f435f6a Uploaded
crs4
parents:
diff changeset
93 not well suited for this type of read depth analysis. The reason is that as the number of cycles is often set to a high
88b89f435f6a Uploaded
crs4
parents:
diff changeset
94 number in order to equalize the representation of each amplicon, which can discard the CNV information.
88b89f435f6a Uploaded
crs4
parents:
diff changeset
95
88b89f435f6a Uploaded
crs4
parents:
diff changeset
96 **License and citation**
88b89f435f6a Uploaded
crs4
parents:
diff changeset
97
88b89f435f6a Uploaded
crs4
parents:
diff changeset
98 This Galaxy tool is Copyright © 2014 `CRS4 Srl.`_ and is released under the `MIT license`_.
88b89f435f6a Uploaded
crs4
parents:
diff changeset
99
88b89f435f6a Uploaded
crs4
parents:
diff changeset
100 .. _CRS4 Srl.: http://www.crs4.it/
88b89f435f6a Uploaded
crs4
parents:
diff changeset
101 .. _MIT license: http://opensource.org/licenses/MIT
88b89f435f6a Uploaded
crs4
parents:
diff changeset
102
88b89f435f6a Uploaded
crs4
parents:
diff changeset
103 You can use this tool only if you agree to the license terms of: `ExomeDepth`_.
88b89f435f6a Uploaded
crs4
parents:
diff changeset
104
88b89f435f6a Uploaded
crs4
parents:
diff changeset
105 .. _ExomeDepth: http://cran.r-project.org/web/packages/ExomeDepth/
88b89f435f6a Uploaded
crs4
parents:
diff changeset
106
88b89f435f6a Uploaded
crs4
parents:
diff changeset
107 If you use this tool, please cite:
88b89f435f6a Uploaded
crs4
parents:
diff changeset
108
88b89f435f6a Uploaded
crs4
parents:
diff changeset
109 - |Cuccuru2014|_
88b89f435f6a Uploaded
crs4
parents:
diff changeset
110 - |Plagnol2012|_.
88b89f435f6a Uploaded
crs4
parents:
diff changeset
111
88b89f435f6a Uploaded
crs4
parents:
diff changeset
112 .. |Cuccuru2014| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2014) Orione, a web-based framework for NGS analysis in microbiology. *Bioinformatics* 30(13), 1928-1929
88b89f435f6a Uploaded
crs4
parents:
diff changeset
113 .. _Cuccuru2014: http://bioinformatics.oxfordjournals.org/content/30/13/1928
88b89f435f6a Uploaded
crs4
parents:
diff changeset
114 .. |Plagnol2012| replace:: Plagnol, V., *et al.* (2012) A robust model for read count data in exome sequencing experiments and implications for copy number variant calling. *Bioinformatics* 28(21), 2747-2754
88b89f435f6a Uploaded
crs4
parents:
diff changeset
115 .. _Plagnol2012: http://bioinformatics.oxfordjournals.org/content/28/21/2747
88b89f435f6a Uploaded
crs4
parents:
diff changeset
116 </help>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
117 <citations>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
118 <citation type="doi">10.1093/bioinformatics/btu135</citation>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
119 <citation type="doi">10.1093/bioinformatics/bts526</citation>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
120 </citations>
88b89f435f6a Uploaded
crs4
parents:
diff changeset
121 </tool>