matrixTests: Matrix Tests

In GranderLab/ClusterSignificanceExtras: A package allowing re-creation of all figures in the publication associated with the ClusterSignificance package

Description

A wrapper for all matrix checks. The function also handles "regeneration", i.e. if a matrix does not pass the checks that it should, it is regenerated until it does. Which tests should be run is controled by the tests arguement.

Arguments

tests	Specifies which tests should be run.
mat	The input matrix.
groups	The groups corresponding to the input matrix.
dim	The dimensions (colums) of the input matrix.
points	The number of points per group in the input matrix.
by	The by variable to the makeMatrix function.
seed	The seed variable to the makeMatrix function.
otherMatrices	Input to the checkIdenticalMatrix function.
desiredOverlap	The desired group overlap.
interspersionThreshold	Input to the interspersion function.
idPointsThreshold	Input to the checkIdenticalDims function.
verbose	Logical if the function should be verbose. Mostly for testing.

Author(s)

Jason Serviss

GranderLab/ClusterSignificanceExtras documentation built on May 6, 2019, 6:30 p.m.