enriched_score {EnrichedHeatmap} | R Documentation

## Enriched scores

### Description

Enriched scores

### Usage

    enriched_score(mat)

### Arguments

`mat` | a normalized matrix from `normalizeToMatrix`

### Details

The function calculates how the signal is enriched in the target by weighting the distance to the target.

For a numeric vector, assume the vector is denoted as combination of three sub-vectors `c(x1, x2, x3)` with length `n1`, `n2` and `n3`, where `x1` are data points in upstream windows, `x2` are data points in target windows and `x3` are data points in downstream windows, the enriched score is calcualted as

sum(x_1i* i/n1) + sum(x_3j* (n3 - j + 1)/n3) + sum(x_2k * abs(n2/2 - abs(k - n2/2)))

where the first two terms are the distance to the start or end position of the target by weighting the distance to the position that if it is closer to the start or end position of the target, it has higher weight. The second term weight the distance to the center point of the target and similar, if it is closer to the center position, it has higher weight.

### Value

A numeric vector

### Author(s)

Zuguang Gu <z.gu@dkfz.de>

### See Also

This `enriched_score` is the default scoring function for `score_fun` argument in `EnrichedHeatmap` function. It is also an example function for implementing customized scoreing function. Basically, to be a score function which calculates enriched score, it should accept three arguments which are the values in upstream windows, the target windows and downstream windows The user-defined function should return a single value. Rows are sorted decreasingly by the enriched scores.

### Examples

    # There is no example
    NULL

[Package EnrichedHeatmap version 1.9.4 Index]