hgate_info: hgate_info

In ebecht/hypergate: Machine Learning of Hyperrectangular Gating Strategies for High-Dimensional Cytometry

hgate_info

Description

Extract information about a hypergate return: the channels of the phenotype, the sign of the channels, the sign of the comparison, the thresholds. The function could also compute the Fscores if the xp, gate_vector and level parameters are given.

Usage

hgate_info(hgate, xp, gate_vector, level, beta = 1)

Arguments

hgate	A hypergate object (produced by hypergate())
xp	The expression matrix from which the 'hgate' parameter originates, needed for Fscore computation
gate_vector	Categorical data from which the 'hgate' parameter originates, needed for Fscore computation
level	Level of gate_vector identifying the population of interest, needed for Fscore computation
beta	Beta to weight purity (low beta) or yield (high beta) more, needed for Fscore computation

Value

A data.frame with channel, sign, comp and threshold columns, and optionnally deltaF (score deterioration when parameter is ignored),Fscore1d (F_value when using only this parameter) and Fscore (F score when all parameters up to this one are included). Fscores are computed if xp, gate_vector and level are passed to the function.

See Also

hg_pheno, hg_rule

Examples

data(Samusik_01_subset)
xp=Samusik_01_subset$xp_src[,Samusik_01_subset$regular_channels]
gate_vector=Samusik_01_subset$labels
hg=hypergate(xp=xp,gate_vector=gate_vector,level=23,delta_add=0.01)
hgate_info(hgate=hg)
hgate_pheno(hgate=hg)
hgate_rule(hgate=hg)

ebecht/hypergate documentation built on Feb. 4, 2024, 3:29 p.m.