Fasano_3DKS: Run a Three-dimensional Kolmogorov-Smirnov Test

Description Usage Arguments Value Examples

View source: R/Fasano_3DKS.R

Description

Run a three-dimensional Kolmogorov-Smirnov test as defined by Fasano and Franceschini (1987). Allows for specification of the number of randomization to perform and the desired alpha level.

Usage

1
Fasano_3DKS(xcol, ycol, zcol, rands = 5000, alpha = 0.05)

Arguments

xcol

a vector of x values

ycol

a vector of y values

zcol

a vector of z values

rands

A numeric indicating how many randomizations to perform. Default is 5000.

alpha

A numeric between 0 and 1 for the desired alpha level. Default is 0.05.

Value

A data frame of summary values and statistics (the maximum D-value; the x, y, z, and p values at the maximum D-value; and the minimum and maximum x, y, and z values for the statistically-significant observations)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
xcol <- rnorm(10)
ycol <- rnorm(10)
zcol <- rnorm(10)

Fasano_3DKS(xcol, ycol, zcol, rands = 2000, alpha = 0.05)

## Not run: 
xcol <- rnorm(10)
ycol <- rnorm(10)
zcol <- rnorm(5)

Fasano_3DKS(xcol, ycol, zcol, rands = 2000, alpha = 0.05)

## End(Not run)

kaitlynstrickfaden/FasanoMDKS documentation built on Dec. 21, 2021, 5:16 a.m.