valid_labels {xnet}

Test the correctness of the labels.

Description

This function checks whether the labels between the Y, K, and G matrices make sense. This means that all the labels found as rownames for y can be found as rownames and column names of k, and all the colnames for y can be found as rownames and colnames of g (if provided).

Usage

valid_labels(y, k, g = NULL)

Arguments

y

the label matrix

k

the kernel matrix for the rows

g

the kernel matrix for the columns (optional). If not available, it takes the value NULL

Details

Compatible labels mean that it is unequivocally clear which rows and columns can be linked throughout the model. In case none of the matrices have row- or colnames, the labels are considered compatible. In all other cases, all matrices should have both row and column names. They should fulfill the following conditions:

• the row- and column names of a kernel matrix must contain the same values in the same order. Otherwise, the matrix can't be symmetric.

• the rownames of y should correspond to the rownames of k

• the colnames of y should correspond to the colnames of g if it is supplied, or the colnames of k in case g is NULL

Value

TRUE if all labels are compatible, an error otherwise.

Note

This is a non-exported convenience function.