annotate heatmap.xml @ 0:a7aa56155a91 draft default tip

Uploaded
author elixir-it
date Thu, 17 Sep 2020 09:40:37 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
1 <tool id="heatmap" name="heatmap" version="1">
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
2 <description>This heatmap provides a simple and rapid way to compare the importance of the different components of the score associated of a set of variants that were scored by VINYL. </description>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
3 <requirements>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
4 <requirement type="package" >r-base</requirement>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
5 </requirements>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
6 <command> <![CDATA[
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
7 Rscript --vanilla $__tool_directory__/tool_heat_score.R
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
8
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
9 ####INPUT
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
10 $fileI $cutoff
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
11
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
12 ###OUTPUT
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
13 $ofile
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
14
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
15 ]]>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
16 </command>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
17 <inputs>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
18 <param format="tabular,csv" name="fileI" type="data" label="scored_tab_file" help="VINYL Tabular output format file. Affected individuals "/>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
19 <param name="cutoff" value="8" min="1" type="float" label="score_cutoff" help="Cut-Off score used for the identification of potentially pathogenic variants"/>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
20
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
21 </inputs>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
22 <outputs>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
23 <data format="png" name="ofile" label="${tool.name} on ${on_string}: png "/>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
24 </outputs>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
25 <stdio>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
26 <regex match="error"
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
27 source="stderr"
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
28 level="fatal"
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
29 description="Unknown error encountered" />
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
30 </stdio>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
31 <tests>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
32 <test>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
33 <param name="fileI" value="heatmap-test.tabular" ftype="tabular" />
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
34 <param name="cutoff" value="30" ftype="float" />
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
35 <output name="ofile" file="heatmap_output.png" ftype="png" />
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
36 </test>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
37 </tests>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
38 <help>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
39 **What it does**
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
40 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.
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
41 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.
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
42
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
43
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
44
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
45 **Important Usage Note**
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
46 This wrapper provides an utility that compares the "features" (i.e the score composition) of a set of variants, scored by VINYL. Ideally this method is best suited to compare a set/ensemble of genetic variants that show a score above a user predefined cut-off, in order to understand which type of the score features evaluated by VINYL were the most important in contributing to the score of each single variants. Clustering is used to display variants that have a similar "scoring composition", that is variants that are associated with similar annotations that display a score above a certain cut-off.
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
47 This utility should be used to find "patterns" in variant scored by VINYL in order to understand, which specific component of the VINYL score (functional annotation element), was important for every distinct variant, but also to identify groups of variants that are associated with "equivalent" functional features.
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
48 To put it simple this tool should show 1) "Why" a variant passed the score cut off (i.e which single components of the score were important for that variant. 2) Which group of variants were associated with similar features.
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
49 A brief discussion on how to read/interpret the output of this tools is also provided in the VINYL manual
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
50 </help>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
51 <citations>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
52 </citations>
a7aa56155a91 Uploaded
elixir-it
parents:
diff changeset
53 </tool>