checks: Sanity checks for input

Description Usage Arguments Format Value Examples

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

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

1
2
3
4
5
6
7
8

b2slab/diffusion documentation built on March 6, 2021, 2:38 a.m.