MUVR2 (version 0.1.0)

permutationPlot: Plot permutation analysis

Description

Plot permutation analysis using actual model and permutation result. This is basically a wrapper for the MUVR2::plotPerm() function using model objects to make coding nicer and cleaner.

Usage

permutationPlot(
  MUVRclassObject,
  permutation_result,
  model = "Mid",
  type = "t",
  side = c("greater", "smaller"),
  pos,
  xlab = NULL,
  xlim,
  ylim = NULL,
  breaks = "Sturges",
  main = NULL
)

Value

A permutation plot

Arguments

MUVRclassObject

A 'MUVR' class object

permutation_result

A permutation result. It is a list of 1 items: permutation_output

model

'Min', 'Mid', or 'Max'

type

't' (default; for Student's t) or 'non' for "non-parametric" (i.e. rank) studen'ts

side

'smaller' for actual lower than H0 or 'greater' for actual larger than H0 (automatically selected if not specified)

pos

which side of actual to put p-value on

xlab

optional xlabel

xlim

optional x-range

ylim

otional y-range

breaks

optional custom histogram breaks (defaults to 'sturges')

main

optional plot title (or TRUE for autoname)

Examples

# \donttest{
data("freelive2")
nRep <- 2
nOuter <- 4
varRatio <-0.6
regrModel <- MUVR2(X = XRVIP2,
                   Y = YR2,
                   nRep = nRep,
                  nOuter = nOuter,
                   varRatio = varRatio,
                   method = "PLS",
                   modReturn = TRUE)
permutation_result<-H0_test(regrModel,n=10)
permutationPlot(regrModel,permutation_result)
# }