annotate barplot.xml @ 0:f5f3f1c07cf1 draft default tip

Uploaded
author elixir-it
date Thu, 17 Sep 2020 09:34:57 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
1 <tool id="barplot" name="barplot" version="1">
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
2 <description> This tools is used to produce a barplot that shows the "importance" of the different components of scoring systems derived by VINYL</description>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
3 <requirements>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
4 <requirement type="package" >r-base</requirement>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
5 </requirements>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
6 <command> <![CDATA[
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
7 Rscript --vanilla $__tool_directory__/tool_barp_score.R
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
8
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
9 ####INPUT
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
10 $fileR $numsys
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
11
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
12 ###OUTPUT
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
13 $ofile
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
14
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
15 ]]>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
16 </command>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
17 <inputs>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
18 <param format="tabular,csv" name="fileR" type="data" label="optim_out" help="Tabular VINYL containing the evaluation of different scoring systems as provided by the VINYL optimizer "/>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
19 <param name="numsys" value="10" min="1" max="30" type="integer" label="tobecompared" help="Number of top-scoring systems to be compared"/>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
20
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
21 </inputs>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
22 <outputs>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
23 <data format="png" name="ofile" label="${tool.name} on ${on_string}: png "/>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
24 </outputs>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
25 <stdio>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
26 <regex match="error"
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
27 source="stderr"
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
28 level="fatal"
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
29 description="Unknown error encountered" />
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
30 </stdio>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
31 <tests>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
32 <test>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
33 <param name="fileR" value="barplott-test.tabular" ftype="tabular" />
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
34 <param name="numsys" value="10" ftype="integer" />
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
35 <output name="ofile" file="barplot_output.png" ftype="png" />
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
36 </test>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
37 </tests>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
38 <help>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
39 **What it does**
f5f3f1c07cf1 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.
f5f3f1c07cf1 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.
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
42
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
43
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
44 **Important Usage Note**
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
45 This wrapper provides a helper tool for VINYL that facilitates the "visual" comparison of the importance of the different components of the optimal VINYL scoring system. Ideally this method can be used to quickly compare any number of scoring systems, although we suggest to limit the comparison to a sensible number (ideally no more than 20). The input this to this tool is the tabular file, as produced by running the VINYL "optimizer", which recapitulates all the different scoring systems that were tested by VINYL on your dataset. This file is already sorted, and the "best" scoring systems are normally found on the top of the file. However, since we empirically observe that several of the scoring systems derived by VINYL, usually attain similar levels of acccuracy/enrichment, comparing the topN scoring systems and the relative importance of different features, can provide additional information that can help you in the selection of the most appropriate system to be applied to your specific use case. A detailed discussion of the possible applications of this tool is provided in the VINYL manual along with a simple example of how to execute the tool, and derive simple observations.
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
46 </help>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
47 <citations>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
48 </citations>
f5f3f1c07cf1 Uploaded
elixir-it
parents:
diff changeset
49 </tool>