multiDimBio (version 1.2.2)

binomPower: Power analysis for estimating the heritability of a binomial trait

Description

Performs a power analysis for estimating the heritability of a binomial trait. This function can take a long time to run if either nsims or nperms is large.

Usage

binomPower(ndads, mm, vv, tau2, nperms, nsims, nbins, alpha = 0.05, doPlot=FALSE)

Value

Returns a list and an optional set of .pdfs (if doPlot==TRUE). The list contains:

roc

a data.frame with the summarized results of the power analysis.

params

a numeric matrix with the paramater values.

results

a numeric matrix with the full results of the analysis.

Arguments

ndads

a (non-empty) numeric value indicating the number of dads.

mm

a (non-empty) numeric value indicating the mean number of offspring per dad per bin (normal dist). mm must be less than vv.

vv

a (non-empty) numeric value indicating the variance in offspring per dad per bin (normal dist). vv. must be greater than mm.

tau2

a (non-empty) numeric value indicating the dad effect (narrow-sense heritability ~ tau2/(tau2+(pi/sqrt(3))^2)).

nperms

a (non-empty) numeric value indicating the number of bootstrap permutations to use for caluclating a p value.

nsims

a (non-empty) numeric value indicating the number of simulations to run per parameter combination.

nbins

a (non-empty) numeric value indicating the number of bins, data are pooled before analysis.

alpha

a (non-empty) numeric value indicating the cutoff for significant p values.

doPlot

a (non-empty) logical value indicating whether to plot the results of the power analysis.

Examples

	ndads <- c(9,18)
	mm <- 4.629634
	vv <- 6.31339
	tau2 <- c(0,0.5)
	nperms <- 2
	nsims <- 2
	nbins <- 3
	doPlot <- TRUE
	binomPower(ndads,mm,vv,tau2,nperms,nsims,nbins,doPlot)