.check_scores {diffuStats} | R Documentation

## Sanity checks for input

### Description

.check_scores ensures that scores are suitable for diffusion

.available_methods is a character vector with the implemented scores

.check_method ensures that 'method' is a valid character

.check_metric ensures that 'metric' is a valid list of metric functions

.check_graph ensures that 'graph' is a valid `igraph` object

.check_K ensures that 'K' is a formally valid kernel. Does not check for spd

### Usage

    .check_scores(scores)

    .available_methods

    .check_method(method)

    .check_metric(metric)

    .check_graph(graph)

    .check_K(K)

### Arguments

`scores` | scores to check
`method` | object to test
`metric` | object to test
`graph` | object to test
`K` | object to test

### Format

An object of class `character` of length 7.

### Value

Functions return `invisible()` but throw warnings and errors as side effect

### Examples

    data(graph_toy)
    diffuStats:::.check_scores(diffuStats:::to_list(graph_toy$input_mat))
    diffuStats:::.check_method("raw")
    diffuStats:::.check_metric(list(auc = metric_fun(curve = "ROC")))
    data(graph_toy)
    diffuStats:::.check_graph(graph_toy)
    data(graph_toy)
    diffuStats:::.check_K(regularisedLaplacianKernel(graph_toy))

[Package diffuStats version 0.104.0 Index]