Mercurial > repos > crs4 > exomedepth
annotate exomedepth.xml @ 7:45af4a9748cf draft
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
author | iuc |
---|---|
date | Fri, 08 Nov 2019 13:25:44 -0500 |
parents | 165732ee5a48 |
children | 5d60331757d3 |
rev | line source |
---|---|
7
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
1 <tool id="exomedepth" name="ExomeDepth" version="1.1.0"> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
2 <description>Calls copy number variants (CNVs) from targeted sequence data</description> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
3 <requirements> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
4 <requirement type="package" version="1.1.10">r-exomedepth</requirement> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
5 </requirements> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
6 <version_command><![CDATA[ |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
7 echo $(R --version | grep version | grep -v GNU)", ExomeDepth version" $(R --vanilla --slave -e "library(ExomeDepth); cat(sessionInfo()\$otherPkgs\$ExomeDepth\$Version)") |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
8 ]]></version_command> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
9 <command detect_errors="exit_code"><![CDATA[ |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
10 Rscript '${__tool_directory__}/exomedepth.R' '$args_file' |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
11 ]]></command> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
12 <configfiles> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
13 <configfile name="args_file"><![CDATA[ |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
14 target=$targetFile |
3 | 15 test_vs_ref=$test_vs_ref |
16 #for $i in $inputs | |
17 bam=${i.input} | |
18 bam_bai=${i.input.metadata.bam_index} | |
19 #if str($i.label.value) != "": | |
20 bam_label=${$i.label.value} | |
21 #else | |
22 bam_label=${i.input.dataset.name} | |
23 #end if | |
24 #end for | |
25 trans_prob=$transition_probability | |
26 output=$output | |
7
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
27 ]]></configfile> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
28 </configfiles> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
29 <inputs> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
30 <param name="targetFile" type="data" format="bed" label="Target regions (BED)"> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
31 <validator type="unspecified_build" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
32 </param> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
33 <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" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
34 <repeat name="inputs" title="BAM" min="2" help="Need to add more files? Use controls below."> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
35 <param name="input" type="data" format="bam" label="BAM file"> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
36 <options> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
37 <filter type="data_meta" ref="targetFile" key="dbkey"/> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
38 </options> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
39 </param> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
40 <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"> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
41 <validator type="regex" message="Spaces are not allowed">^\S*$</validator> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
42 </param> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
43 </repeat> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
44 <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" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
45 </inputs> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
46 <outputs> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
47 <data name="output" format="tabular" label="${tool.name} on ${on_string}" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
48 </outputs> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
49 <tests> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
50 <test> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
51 <param name="targetFile" value="CNV_TruSeq_Chr2.bed" dbkey="hg19" ftype="bed"/> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
52 <param name="test_vs_ref" value="True"/> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
53 <repeat name="inputs"> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
54 <param name="input" value="CNV_case_small.bam"/> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
55 </repeat> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
56 <repeat name="inputs"> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
57 <param name="input" value="CNV_control_small.bam"/> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
58 </repeat> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
59 <param name="transition_probability" value="0.5"/> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
60 <output name="output"> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
61 <assert_contents> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
62 <has_text text="chr2" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
63 <has_text text="97890544" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
64 <has_text text="97890616" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
65 <has_text text="deletion" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
66 <has_text text="CNV_case_small" /> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
67 </assert_contents> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
68 </output> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
69 </test> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
70 </tests> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
71 <help><![CDATA[ |
3 | 72 .. class:: warningmark |
73 | |
74 **Warning about counts for chromosome X** | |
75 | |
76 Calling CNVs on the X chromosome can create issues if the exome sample of interest and the reference exome | |
77 samples it is being compared to are not gender matched. | |
78 Make sure that the genders are matched properly (i.e. do not use male as a reference for female | |
79 samples and vice versa). | |
80 | |
81 **What it does** | |
82 | |
83 This tool uses ExomeDepth to call copy number variants (CNVs) from targeted sequence data. | |
84 | |
85 **Output format** | |
86 | |
87 =========== ======================== | |
88 Column Description | |
89 ----------- ------------------------ | |
90 chr Chromosome | |
91 start Start of CNV region | |
92 end End of CNV region | |
93 type CNV type (deletion, duplication) | |
94 sample Name of the sample with CNV | |
95 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) | |
96 nexons Number of target regions covered by the CNV | |
97 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 | |
98 reads.ratio Observed/expected reads ratio | |
99 =========== ======================== | |
100 | |
101 | |
102 **What ExomeDepth does and does not do** | |
103 | |
104 ExomeDepth uses read depth data to call CNVs from exome sequencing experiments. A key idea is that the test | |
105 exome should be compared to a matched aggregate reference set. This aggregate reference set should combine | |
106 exomes from the same batch and it should also be optimized for each exome. It will certainly differ from one exome | |
107 to the next. | |
108 | |
109 Importantly, ExomeDepth assumes that the CNV of interest is absent from the aggregate reference set. Hence | |
110 related individuals should be excluded from the aggregate reference. It also means that ExomeDepth can miss | |
111 common CNVs, if the call is also present in the aggregate reference. ExomeDepth is really suited to detect rare | |
112 CNV calls (typically for rare Mendelian disorder analysis). | |
113 | |
114 The ideas used in this package are of course not specific to exome sequencing and could be applied to other | |
115 targeted sequencing datasets, as long as they contain a sufficiently large number of exons to estimate the parameters | |
116 (at least 20 genes, say, but probably more would be useful). Also note that PCR based enrichment studies are often | |
117 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 | |
118 number in order to equalize the representation of each amplicon, which can discard the CNV information. | |
7
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
119 ]]></help> |
3 | 120 <citations> |
7
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
121 <citation type="doi">10.1093/bioinformatics/btu135</citation> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
122 <citation type="doi">10.1093/bioinformatics/bts526</citation> |
45af4a9748cf
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/exomedepth commit 91a0182476a7fc26be7bef1677790518c4e88348"
iuc
parents:
6
diff
changeset
|
123 </citations> |
3 | 124 </tool> |