summarizeEffectParameters: Summary Statistics of Effect Parameters

View source: R/Summaries.R

summarizeEffectParametersR Documentation

Summary Statistics of Effect Parameters

Description

Calculates summary statistics, like mean, median, and credible interval, of effect parameters.

Usage

summarizeEffectParameters(effects, fList = list(mean = mean), ps = c(0.025,
  0.5, 0.975))

Arguments

effects

A matrix, such as from getEffectParameters, where each column is one parameter and each row is an iteration. If the columns are named with the name of the effect, those names will be used.

fList

A named list of functions of one vector argument that will be applied to the effects individually.

ps

Proportions for which quantiles will be calculated. By default, the median and 95% credible interval is calculated.

Details

Note that equality/inequality of effect parameters should not be determined based on their individual credible intervals. You should instead use the credible interval of their difference, which is done by groupEffectParameters by default.

Value

A data.frame with summary statistics for each column in effects.

See Also

For plotting the result of this function, plotEffectParameterSummary. For grouping indistinguishable effects, groupEffectParameters.


hardmanko/CMBBHT documentation built on June 9, 2022, 12:44 a.m.