overlapMatrices: Overlap Specific Matrices

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

Description

Generates matrices where the groups have a specific percentage of overlap with each other.

Arguments

reps	The desired number of overlap specific matrices to generate for each overlap.
overlaps	A numerical vector containing all of the overlaps to be generated.
dim	The number of dimensions (columns) to generate. Passed to the makeMatrix function.
points	The number of data points in each group. Passed to the makeMatrix function.
by	Passed to the makeMatrix function.
verbose	Should the function be verbose?
save	Should output be saved?

Details

The function generates overlap specific matrices. It can do this either for a specific overlap or many at once. It is also capable of generating replicates for a single overlap value. All matrices must pass multiple tests before they are accepted with which tests they must pass being dependant on the desired overlap. This function has only been tested with the dim, points, and by values set to their defaults as it utilizes the overlapProbability output and the dynamicXY function.

Author(s)

Jason Serviss

Examples

matrices <- overlapMatrices(
   reps=2,
   overlaps=0,
   dim=2,
   points=10,
   save=FALSE,
   verbose=FALSE
)

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