getPerm5Num: Get descriptive statistics from a permutation object

Description Usage Arguments Value Examples

View source: R/stats.R

Description

The getPerm5Num function returns the "five number summary", a descriptive statistic that consists of the minimum, first (lower) quartile, median, third (upper) quartile and maximum value of a given distribution. In this case, the function is applied directly on the output of permutation testing, generated by the cfPermute function.

Usage

1
getPerm5Num(permObj)

Arguments

permObj

The permutation object as generated by cfPermute

Value

The getPerm5Num function returns an R object in the form of a list that contains the five number summary. The names of the returned statistics can be viewed by using the function attributes.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## Not run: 
data(iris)

irisClass <- iris[,5]
irisData  <- iris[,-5]

permObj <- cfPermute(irisData, irisClass, bootNum = 10, ensNum = 20, permNum = 5, 
                     parallel = TRUE, cpus = 4, type = "SOCK")

getPerm5Num(permObj)
getPerm5Num(permObj)$median      
getPerm5Num(permObj)$minimum
getPerm5Num(permObj)$maximum
getPerm5Num(permObj)$upperQ
getPerm5Num(permObj)$lowerQ

## End(Not run)

classyfire documentation built on May 29, 2017, 11:05 p.m.