verify.ss.aipe.R2: Internal MBESS function for verifying the sample size in...

View source: R/verify.ss.aipe.R2.R

verify.ss.aipe.R2R Documentation

Internal MBESS function for verifying the sample size in ss.aipe.R2

Description

Internal function called upon by ss.aipe.R2 when verify.ss=TRUE. This function then calls upon ss.aipe.R2.sensitivity for the simulation study.

Usage

verify.ss.aipe.R2(Population.R2 = NULL, conf.level = 0.95, width = NULL, 
Random.Predictors = TRUE, which.width = "Full", p = NULL, n = NULL, 
degree.of.certainty = NULL, g = 500, G = 10000, print.iter=FALSE, ...)

Arguments

Population.R2

value of the population multiple correlation coefficient

conf.level

confidence interval level (e.g., .95, .99, .90); 1-Type I error rate

width

width of the confidence interval (see which.width)

Random.Predictors

whether or not the predictor variables are random (set to TRUE) or are fixed (set to FALSE)

which.width

defines the width that width refers to

p

the number of predictor variables

n

starting sample size (i.e., from ss.aipe.R2)

degree.of.certainty

value with which confidence can be placed that describes the likelihood of obtaining a confidence interval less than the value specified (e.g., .80, .90, .95)

g

simulations for the preliminary sample size (much smaller than G)

G

number of replications for the actual Monte Carlo simulation (should be large)

print.iter

specify whether or not the internal iterations should be printed

...

additional arguments passed to internal functions

Details

This function is internal to MBESS and is called upon when verify.ss=TRUE in the ss.aipe.R2 function. Although users can use verify.ss.aipe.R2 directly, it is not recommended.

Value

Returns the exact (provided G is large enough) sample size necessary to satisfy the conditions specified.

Author(s)

Ken Kelley (University of Notre Dame; KKelley@ND.Edu)


MBESS documentation built on Oct. 26, 2023, 9:07 a.m.