getTau: Estimate tau

Description Usage Arguments Value

View source: R/estimateTau.R

Description

Main function used to estimate variation in multivariate proportion data. Uses an objective function to minimize difference between sum of squares of observed vs. simulated standard deviations for proportions data. Note that objective function is constrained to sample between 0 and 3 at intervals of 0.1; however that should be sufficient for most proportion data.

Usage

1
getTau(ppnMat, plotTaus = TRUE)

Arguments

ppnMat

Matrix of proportion data to apply grid search for tau to.

plotTaus

If true (default), tau-specific values from objective function are plotted allowing users to visually identify minimum.

Value

A list containing a vector of tau-specific objective function values (*objFun*) and a numeric representing the tau value that minimizes the objective function (*bestTau*).


TESA-workshops/TESAsamSim documentation built on Feb. 6, 2021, 12:25 a.m.