amelieStudy: How significant are your Amelie annotations?

Description Usage Arguments Value

View source: R/anntation.R

Description

Amelie annotations on you gene predictions are great as a first step to a more in deep search in the literature for papers backing up your predictions. However, Amelie can be useful as well to calibrate how effective are your predictions, i.e. if we are doing better than random chance when predicting gene assocations with phenotype. This method encapsulates all the stuff for you.

Usage

1
2
amelieStudy(rndfile = NULL, ameliefile = NULL, doplot = F,
  panel = "PD", ensemble = NULL, phenotype = NULL, nNull = 100)

Arguments

rndfile

A file with the RDS results of a call to annotateWithAmelie(). Note that depending on the number of random calls you wanted to make with Amelie, calling that method with getNullDistribution set to TRUE can take some time. Besides, once you made a call for a phenotype, there is no need to do it again for the same phenotype.

ameliefile

A file with the RDS results of a call to annotateWithAmelie() with getNullDistribution set to FALSE.

doplot

If TRUE, it will generate a plot with comparison between random chance and your predictions in regard to number of hits and quality of predictions

panel

A string with a pretty name for the panel as we want it to appear in the plots titles

ensemble

The result to call caret::ensembleLearnKFold

phenotype

A list of HPO terms that match the phenotype represented by your gene panel. You can get your list of phenotypes by browsing at http://hpo.jax.org/

nNull

The number of random queries for Amelie

Value

A list with three elements. They are all vectors with 'nNull' + 1 length. The first 'nNull' values of all the three vectors correspond to random queries, the 'nNull' + 1 is the result of the Amelie query with your predictions. The first vector shows the number of assocations found. The second vector the mean scores for the associations. The last vector all results for each query. It generates a plot when 'doplot' is set to TRUE.


juanbot/G2PML documentation built on Aug. 1, 2020, 5:07 a.m.