checkAdjMat: Check adjacency matrix

Description Usage Arguments Details Value Author(s) See Also

Description

Checks a given matrix for properties that an adjacency matrix must satisfy.

Usage

1
2
checkAdjMat(adjMat, min = 0, max = 1)
checkSimilarity(similarity, min = -1, max = 1)

Arguments

adjMat

matrix to be checked

similarity

matrix to be checked

min

minimum allowed value for entries of the input

max

maximum allowed value for entries of the input

Details

The function checks whether the given matrix really is a 2-dimensional numeric matrix, whether it is square, symmetric, and all finite entries are between min and max. If any of the conditions is not met, the function issues an error.

Value

None. The function returns normally if all conditions are met.

Author(s)

Peter Langfelder

See Also

adjacency



Search within the WGCNA package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.