annotate old_version/optimizer_M.xml @ 2:6e4eb4856874 draft

Uploaded
author elixir-it
date Wed, 22 Jul 2020 19:20:30 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
1 <tool id="optimizer" name="optimizer" version="1">
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
2 <description> Optimizer</description>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
3 <requirements>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
4 <requirement type="package" >perl</requirement>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
5 <requirement type="package" >r-base</requirement>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
6 </requirements>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
7 <command> <![CDATA[
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
8 ln -s $__tool_directory__/score_complete_alt_M.pl 2>$log &&
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
9 ln -s $__tool_directory__/wilcox.R 2>>$log &&
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
10 ln -s $__tool_directory__/survival_optM.R 2 >> $log &&
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
11 ln -s $fileR fileR &&
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
12 ln -s $fileC fileC &&
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
13
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
14
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
15
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
16
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
17 perl $__tool_directory__/optimizer_M.pl
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
18
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
19
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
20 ###INPUT VCF FILE
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
21
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
22 -fileR fileR -fileC fileC
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
23
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
24
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
25
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
26
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
27 #if $qfile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
28 -leQTL $qfile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
29 #end if
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
30
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
31 #if $similarD
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
32 -similarD $similarD
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
33 #end if
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
34
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
35 #if $disease
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
36 -disease $disease
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
37 #end if
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
38
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
39 #if $lgenes
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
40 -lgenes $lgenes
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
41 #end if
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
42
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
43 #if $kfile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
44 -keywords $kfile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
45 #else
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
46 -keywords $__tool_directory__/kfile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
47 #end if
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
48
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
49 #if $efile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
50 -effects $efile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
51 #else
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
52 -effects $__tool_directory__/efile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
53 #end if
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
54
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
55 #if $ifile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
56 -ifile $ifile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
57 #end if
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
58
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
59 ###RANGE VALUES
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
60 -disease_clinvar $score_DB_MIN:$score_DB_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
61
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
62 -score_AF $score_RVM_IN:$score_RV_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
63
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
64 -score_functional $score_FE_MIN:$score_FE_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
65
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
66 -score_NS $score_NS_MIN:$score_NS_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
67
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
68 -score_nIND $score_OR_MIN:$score_OR_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
69
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
70 -AF $AF
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
71
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
72 -scoreeQTL $score_eQ_MIN:$score_eQ_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
73
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
74 -scoreG $score_AD_MIN:$score_AD_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
75
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
76 -scoreI $score_GD_MIN:$score_GD_MAX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
77
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
78 -nind $nind
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
79
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
80 -AD $AD
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
81
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
82 -XL $XL
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
83
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
84 ###OUTPUT
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
85 -ofile $ofile
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
86
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
87 2>>$log
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
88
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
89
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
90
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
91 ]]>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
92 </command>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
93 <inputs>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
94 <param format="vcf" name="fileR" type="data" label="AffectedVCF" help="VCF files of genetic variants for the population of affected individuals"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
95 <param format="vcf" name="fileC" type="data" label="UnaffectedVCF" help="VCF files of genetic variants for the population of unaffected individuals"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
96 <!-- default values-->
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
97 <param name="score_DB_MIN" value="4" type="integer" min="1" max="12" label="score_DB_MIN" help="Minimum value for the Pathogenicity score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
98 <param name="score_DB_MAX" value="6" type="integer" min="1" max="12" label="score_DB_MAX" help="Maximum value for the Pathogenicity score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
99 <param name="score_RVM_IN" value="2" type="integer" min="1" max="12" label="score_RV_MIN" help="Minum value for the Allele Frequency score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
100 <param name="score_RV_MAX" value="4" type="integer" min="1" max="12" label="score_RV_MAX" help="Maximum value for the Allele Frequency score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
101 <param name="score_FE_MIN" value="4" min="1" max="12" type="integer" label="score_FE_MIN" help="Minimum value for the Functional effect score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
102 <param name="score_FE_MAX" value="6" min="1" max="12" type="integer" label="score_FE_MAX" help="Maximum value for the Functional effect score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
103 <param name="score_NS_MIN" value="2" min="1" max="12" type="integer" label="score_NS_MIN" help="Minum value for component of the score associated with Predicted disruptive non-synonymous variants"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
104 <param name="score_NS_MAX" value="4" min="1" max="12" type="integer" label="score_NS_MAX" help="Maximum value for the score component of the score associated with Predicted disruptive non-synonymous variants"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
105 <param name="score_OR_MIN" value="2" type="integer" min="1" max="12" label="score_OR_MIN" help="Minimum value for the component of the score associated with over-representation of the variant in the dataset (Rare variants associated to more than N individuals) "/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
106 <param name="score_OR_MAX" value="4" type="integer" min="1" max="12" label="score_OR_MAX" help="Maximum value for the component of associated with over-representation of the variant in the dataset (Rare variants associated to more than N individuals)" />
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
107 <param name="score_eQ_MIN" value="2" min="1" max="12" type="integer" help="Minimum value for the component of the score associated with eQTLs"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
108 <param name="score_eQ_MAX" value="4" min="1" max="12" type="integer" help="Maximum value for the component of the score associated with eQTLs"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
109 <param name="score_AD_MIN" value="3" min="1" max="12" type="integer" label="score_AD_MIN" help="Minimum value for the component of the score associated with genes implicated in the pathological condition or associated with similar phenotypes" />
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
110 <param name="score_AD_MAX" value="5" min="1" max="12" type="integer" label="score_AD_MAX" help="Minimum value for the component of the score associated with genes implicated in the pathological condition or associated with similar phenotypes" />
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
111 <param name="score_GD_MIN" value="0.1" min="0.1" max="1" type="float" label="score_GD_MIN" help="Minimum value for the Protein-Protein interaction score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
112 <param name="score_GD_MAX" value="0.3" min="0.1" max="1" type="float" label="score_GD_MAX" help="Maximum value for the Protein-Protein interaction score component"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
113
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
114 <param name="nind" value="5" type="integer" label="Nind Cutoff" help="Cut off value for the Over-reprentation score. The value specified by scoreNind is addeded to the pathogenicity score only for variants that have an allele count in the cohort equal to or greater than this value. As a rule of tumb, this should be set to approximately 5-10% of the size of your cohort of individuals"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
115 <param name="AF" value="0.0001" min="0" max="1" type="float" label="AlleleFrequCutOff" help="Cut off value for the Allele frequency score. The value specified by scoreAF is addeded to the pathogenicity score only for variants that have an allele frequency lower or equal to this cut-off value " />
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
116 <param name="AD" type="text" value="T" label="Autosomic Dominant" help="If set to T (TRUE) VYNIL assumes an Autosomic Dominant model of inherithance of the disease. If FALSE (F) the model is Autosomic Recessive. Valid values are T=TRUE or F=FALSE Default is T"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
117 <param name="XL" type="text" value="F" label="X-linked" help="When T (TRUE) an X-linked model of Disease inheritance is used. Valid values are T=TRUE and F=FALSE. Default is FALSE" />
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
118
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
119
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
120 <!--optional values -->
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
121 <param format="txt" name="kfile" type="data" optional="true" label="keywords file" help="This is a configuration file that specifies the keywords that are used by VINYL for the extraction of relevant annoations from the VCF file and for the computation of the pathogenicity score. Names of these keywords need to match exactly names as used by Annovar. A file with default values is incorporated in VINYL. Custom files can be provided (see Manual for the format) "/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
122 <param format="txt" name="efile" type="data" optional="true" label="Functional Effects files" help="This configuration file specifies the predicted functional effects for which the value specified by the score_functional parameter is be added to the global pathogenicity score. See above for further explanations."/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
123 <param format="txt" name="qfile" type="data" optional="true" label="eQTLlist" help="This configuration file provides a list of tissues that are used by VINYL for the annotation of eQTL and the scoring of variants associated with eQTLs in that tissue. Names of tissues need match names used in the GTEx project. See the manual for more details about the format of the file "/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
124 <param format="txt" name="ifile" type="data" optional="true" label="Protein-Protein interaction file" help="By default this file provides protein-protein interaction data according to the string database (https://string-db.org/). Alternative files can be specified by the user. See the manual of VINYL for a detailed discussion of the format"/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
125 <param name="disease" type="text" optional="true" label="Disease" help="Name or functional description of the pathological condition. This parameter is used to perform a soft check of the annotation in Clinvar and to identify variants that have been previously implicated in the disease. Highly recommended. "/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
126 <param name="similarD" type="data" format="txt" optional="true" label="Symptoms" help="This file provides a list of symptoms or related keywords that are used by VINYL to screen the Annotations of Clinvar and identify variants that have been implicated in similar pathologies or phenotype. See the manual for a full description of the file format. User are strongly encouraged to provide this file "/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
127 <param name="lgenes" type="data" format="txt" optional="true" label="List of Disease Genes" help="This file provides a list of genes that have been previously implicated in the disease of in similar pathological conditions. Users are highly recommended to provide this type of information. A full desciption of the format of this file is found in the VYNIL manual" />
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
128
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
129
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
130 <!--others-->
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
131
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
132 </inputs>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
133 <outputs>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
134 <data format="txt" name="log" label="${tool.name} on ${on_string}: log file "/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
135 <data format="tabular" name="ofile" label="${tool.name} on ${on_string}: tabular "/>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
136 </outputs>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
137 <stdio>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
138 </stdio>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
139 <tests>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
140 <test>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
141 </test>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
142 </tests>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
143 <help>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
144 **What it does**
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
145 VINYL is a software designed to assist in variant prioritization in medium-large cohort of patients. The program computes an aggregate score, which is based on an extensive collection of publicly available annotations, in order to identify/prioritize variants that are likely to be pathogenic or have a clinical significance. In order to derive an optimal cut off score for the variants, VINYL uses a strategy based on "survival analysis", where the pathogenicity score distribution of the affected individuals is compared with a matched cohort of unaffected individuals.
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
146 To facilitate the usage of the software, VINYL is provided in the form of a public Galaxy instance, based on the Laniakea suite. To ensure the maximum level of security, VINYL uses Encrypted data volumes for the storage of the data.
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
147
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
148
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
149
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
150 **Important Usage Note**
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
151 This wrapper provides the module of VINYL that perform score optimization. Two input VCF files need to be provided, one containing genetic variants from a cohort of affected individuals, and one from a population of unaffected controls. If the latter is not available to you, you can take advantage of one of the several VCF files of genetic variants associated with geographic human populations that are available in VINYL at XXX. Please be aware that ideally you should select the population that is more closely related to your cohort of patients. If you have performed a targeted resequencing study, please see the manual for instruction on how to pre-process the VCF files included in VINYL.
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
152
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
153 See the "survival" and the "VINYL" utilities in the for the delineation of the score cut-off value and the calculation of individual scores from a single vcf file.
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
154 A complete workflow that automates the exectuion of VINYL is avaiable at XXX
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
155
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
156
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
157 </help>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
158 <citations>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
159 </citations>
6e4eb4856874 Uploaded
elixir-it
parents:
diff changeset
160 </tool>