annotate optimizer_genetic.xml @ 2:6e4eb4856874 draft

Uploaded
author elixir-it
date Wed, 22 Jul 2020 19:20:30 +0000
parents 35c308dd6420
children 221db2eb3c8e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
1 <tool id="optimizer" name="optimizer" version="1">
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
2 <description> VINYL score optimizer applies genetic algorithms to identify the best scoring system (i.e. scoring weights) for VINYL</description>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
3 <requirements>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
4 <requirement type="package" >perl</requirement>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
5 <requirement type="package" >r-base</requirement>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
6 <requirement type="package" >r-genalg</requirement>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
7 </requirements>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
8 <command> <![CDATA[
2
6e4eb4856874 Uploaded
elixir-it
parents: 1
diff changeset
9 ln -s $__tool_directory__/score_complete_alt_M.pl 2>$log &&
6e4eb4856874 Uploaded
elixir-it
parents: 1
diff changeset
10 ln -s $__tool_directory__/GENEO_VINYL.R 2>> $log &&
0
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
11 ln -s $fileR fileR &&
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
12 ln -s $fileC fileC &&
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
13
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
14
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
15
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
16
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
17 perl $__tool_directory__/optimizer_genetic.pl
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
18
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
19
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
20 ###INPUT VCF FILE
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
21
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
22 -fileR fileR -fileC fileC
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
23
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
24 #if $qfile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
25 -leQTL $qfile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
26 #end if
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
27
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
28 #if $similarD
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
29 -similarD $similarD
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
30 #end if
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
31
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
32 #if $disease
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
33 -disease $disease
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
34 #end if
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
35
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
36 #if $lgenes
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
37 -lgenes $lgenes
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
38 #end if
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
39
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
40 #if $kfile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
41 -keywords $kfile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
42 #else
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
43 -keywords $__tool_directory__/kfile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
44 #end if
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
45
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
46 #if $efile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
47 -effects $efile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
48 #else
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
49 -effects $__tool_directory__/efile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
50 #end if
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
51
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
52
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
53 ###RANGE VALUES
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
54 -disease_clinvar $score_DB_MIN:$score_DB_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
55
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
56 -score_AF $score_RV_MIN:$score_RV_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
57
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
58 -score_functional $score_FE_MIN:$score_FE_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
59
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
60 -score_NS $score_NS_MIN:$score_NS_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
61
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
62 -score_nIND $score_OR_MIN:$score_OR_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
63
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
64 -AF $AF
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
65
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
66 -scoreeQTL $score_eQ_MIN:$score_eQ_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
67
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
68 -scoreG $score_AD_MIN:$score_AD_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
69
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
70 -scoreT $score_T_MIN:$score_T_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
71
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
72 -scoreGW $score_GW_MIN:$score_GW_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
73
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
74 -scoreR $score_R_MIN:$score_R_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
75
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
76 -scoreM $score_M_MIN:$score_M_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
77
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
78 -scoreSP $score_SP_MIN:$score_SP_MAX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
79
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
80 -nind $nind
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
81
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
82 -AD $AD
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
83
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
84 -XL $XL
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
85
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
86 ###OUTPUT
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
87 -ofile $ofile
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
88
2
6e4eb4856874 Uploaded
elixir-it
parents: 1
diff changeset
89 2>>$log
0
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
90
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
91
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
92
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
93 ]]>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
94 </command>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
95 <inputs>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
96 <param format="vcf" name="fileR" type="data" label="AffectedVCF" help="VCF files of genetic variants for the population of affected individuals"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
97 <param format="vcf" name="fileC" type="data" label="UnaffectedVCF" help="VCF files of genetic variants for the population of unaffected individuals"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
98 <!-- default values-->
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
99 <param name="score_DB_MIN" value="1" type="float" min="1" max="20" label="score_DB_MIN" help="Minimum value for the Pathogenicity score component"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
100 <param name="score_DB_MAX" value="20" type="float" min="1" max="20" label="score_DB_MAX" help="Maximum value for the Pathogenicity score component"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
101 <param name="score_RV_MIN" value="1" type="float" min="1" max="20" label="score_RV_MIN" help="Minum value for the Allele Frequency score component"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
102 <param name="score_RV_MAX" value="20" type="float" min="1" max="20" label="score_RV_MAX" help="Maximum value for the Allele Frequency score component"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
103 <param name="score_FE_MIN" value="1" min="1" max="20" type="float" label="score_FE_MIN" help="Minimum value for the Functional effect score component"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
104 <param name="score_FE_MAX" value="20" min="1" max="20" type="float" label="score_FE_MAX" help="Maximum value for the Functional effect score component"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
105 <param name="score_NS_MIN" value="1" min="1" max="20" type="float" label="score_NS_MIN" help="Minum value for component of the score associated with Predicted disruptive non-synonymous variants"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
106 <param name="score_NS_MAX" value="20" min="1" max="20" type="float" label="score_NS_MAX" help="Maximum value for the score component of the score associated with Predicted disruptive non-synonymous variants"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
107 <param name="score_OR_MIN" value="1" type="float" min="1" max="20" 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) "/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
108 <param name="score_OR_MAX" value="20" type="float" min="1" max="20" 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)" />
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
109 <param name="score_eQ_MIN" value="1" min="1" max="20" type="float" help="Minimum value for the component of the score associated with eQTLs"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
110 <param name="score_eQ_MAX" value="20" min="1" max="20" type="float" help="Maximum value for the component of the score associated with eQTLs"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
111 <param name="score_AD_MIN" value="1" min="1" max="20" type="float" 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" />
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
112 <param name="score_AD_MAX" value="20" min="1" max="20" type="float" 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" />
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
113 <param name="score_T_MIN" value="1" min="1" max="20" type="float" label="score_T_MIN" help="Minimum value for the component of the score associated with TFBS"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
114 <param name="score_T_MAX" value="20" min="1" max="20" type="float" label="score_T_MAX" help="Maximum value for the component of the score associated with TFBS"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
115 <param name="score_GW_MIN" value="1" min="1" max="20" type="float" label="score_GW_MIN" help="Minimum value for component of the score for SNPs associated to relevant phenotypic traits according to GWAS studies"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
116 <param name="score_GW_MAX" value="20" min="1" max="20" type="float" label="score_GW_MAX" help="Maximum value for component of the score for SNPs associated to relevant phenotypic traits according to GWAS studies"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
117 <param name="score_M_MIN" value="1" min="1" max="20" type="float" label="score_M_MIN" help="Minimum score for SNPs associated with miRNA binding sites"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
118 <param name="score_M_MAX" value="20" min="1" max="20" type="float" label="score_M_MAX" help="Maximum score for SNPs associated with miRNA binding sites"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
119 <param name="score_R_MIN" value="1" min="1" max="10" type="float" label="score_R_MIN" help="Minimum value for the component of the score associated with regulatory elements SNPs"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
120 <param name="score_R_MAX" value="20" min="1" max="20" type="float" label="score_R_MAX" help="Maximum value for the component of the score associated with regulatory elements SNPs"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
121 <param name="score_SP_MIN" value="1" min="1" max="10" type="float" label="score_SP_MIN" help="Minimum value for the component of the score associated with SNPs predicted to have highly disruptive effects on splice-sites"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
122 <param name="score_SP_MAX" value="20" min="1" max="20" type="float" label="score_SP_MAX" help="Maximum value for the component of the score associated with SNPs predicted to have highly disruptive effects on splice-sites"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
123
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
124
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
125 <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"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
126 <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 " />
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
127 <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"/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
128 <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" />
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
129
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
130
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
131 <!--optional values -->
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
132 <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) "/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
133 <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."/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
134 <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 "/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
135 <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. "/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
136 <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 "/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
137 <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" />
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
138
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
139
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
140 <!--others-->
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
141
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
142 </inputs>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
143 <outputs>
2
6e4eb4856874 Uploaded
elixir-it
parents: 1
diff changeset
144 <data format="txt" name="log" label="${tool.name} on ${on_string}: log file "/>
0
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
145 <data format="tsv" name="ofile" label="${tool.name} on ${on_string}: tsv "/>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
146 </outputs>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
147 <stdio>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
148 </stdio>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
149 <tests>
2
6e4eb4856874 Uploaded
elixir-it
parents: 1
diff changeset
150 <test>
6e4eb4856874 Uploaded
elixir-it
parents: 1
diff changeset
151 </test>
0
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
152 </tests>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
153 <help>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
154 **What it does**
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
155 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.
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
156 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.
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
157
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
158
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
159
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
160 **Important Usage Note**
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
161 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.
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
162
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
163 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.
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
164 A complete workflow that automates the exectuion of VINYL is avaiable at XXX
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
165
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
166
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
167 </help>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
168 <citations>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
169 </citations>
4c6529d120c3 Uploaded
elixir-it
parents:
diff changeset
170 </tool>