get_puretumor: Purify subgroup profiles

View source: R/get_puretumor.R

get_puretumorR Documentation

Purify subgroup profiles

Description

Purify subgroup profiles

Usage

get_puretumor(subgroup, pp = NULL, minkappa = NULL, loglevel = "INFO")

Arguments

subgroup

The profiles of subgoups and control groups for each clinical query sample.

pp

a GxM matrix, representing the expression profiles whose convex combination form the prior over the purified cancer profile learned.

minkappa

(optional) The minimum value allowed for the strength parameter kappa placed over the reference cancer profile m (see Quon et al, 2013). By default, this is set to 1/min(BB), such that the log likelihood of the model is always finite. However, when the min(BB) is very small, this forces MIN_KAPPA to be very large, and can sometimes cause the reference profile m to look too much like a 'normal profile' (and therefore you may observe the tumor samples having low % cancer content estimates). If this is the case, you can try setting MIN_KAPPA=1, or some other small value. For reference, for the data presented in Quon et al., 2013, MIN_KAPPA is on the order of 10^5.

loglevel

(optional) A string that gives the logging threshold for futile.logger. The possible options are 'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'. Currently the messages in ISOpureR are only in the categories 'INFO', 'WARN', and 'FATAL', and the default setting is 'INFO'. Setting a setting for the entire package will over-ride the setting for a particular function.

Value

The purified profiles of subgoups and control groups for each clinical query sample.


AllenSpike/CPDR documentation built on April 18, 2022, 4:38 p.m.