view barplot.xml @ 0:f5f3f1c07cf1 draft default tip

Uploaded
author elixir-it
date Thu, 17 Sep 2020 09:34:57 +0000
parents
children
line wrap: on
line source

<tool id="barplot" name="barplot" version="1">
  <description> This tools is used to produce a barplot that shows the "importance" of the different components of scoring systems derived by VINYL</description>
  <requirements>
    <requirement type="package" >r-base</requirement>
  </requirements>
  <command> <![CDATA[
	Rscript --vanilla $__tool_directory__/tool_barp_score.R
	
	####INPUT
	$fileR $numsys

	###OUTPUT
	$ofile

    ]]>
  </command>
  <inputs>
	<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 "/>
        <param name="numsys" value="10" min="1" max="30" type="integer" label="tobecompared" help="Number of top-scoring systems to be compared"/>

  </inputs>
  <outputs>
    <data format="png" name="ofile" label="${tool.name} on ${on_string}: png "/>
  </outputs>
  <stdio>
    <regex match="error"
            source="stderr"
            level="fatal"
            description="Unknown error encountered" />
  </stdio>
  <tests>
      <test>
        <param name="fileR" value="barplott-test.tabular" ftype="tabular" />
        <param name="numsys" value="10" ftype="integer" />
        <output name="ofile" file="barplot_output.png" ftype="png" /> 
      </test>
  </tests>
  <help>
**What it does**
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.
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.


**Important Usage Note**
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.
</help>
  <citations>
  </citations>
</tool>