getTau: Estimate tau
In CamFreshwater/samSim: Closed-loop salmon dynamics simulator
getTau R Documentation
Estimate tau
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
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*).
CamFreshwater/samSim documentation built on Sept. 25, 2023, 10:22 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| getTau | R Documentation |
Estimate tau
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
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*).
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.