parameters-methods: Parameter values for MPT models

Description Usage Arguments Details Value Author(s) See Also

Description

Generic function to display the parameter values and confidence intervals for MPT models.

Usage

1
2
3
4
## S4 method for signature 'mpt'
parameters(object, ci = NULL, show.equality = FALSE, show.fixed = TRUE, sort.alphabetical = FALSE, ...)
## S4 method for signature 'bmpt'
parameters(object, type = c("nonparametric", "parametric", "fisher"), ci = NULL, show.equality = FALSE, show.fixed = TRUE, sort.alphabetical = FALSE, ...)

Arguments

object

object of class mpt or bmpt

type

type of confidence interval to be displayed. Other types than fisher are only possible for objects of class bmpt and when the relevant calculations have already been done (which are currently not implemented).

ci

numeric or NULL. Size of confidence interval. If NULL (the default) the value is taken from objects's slot default.ci (default = 95).

show.equality

Logical. Should all parameters that are euqal to other be displayed? If FALSE (the default) only the parameter that is estimated is displayed and all that are equal to this one ommited.

show.fixed

Logical. Should parameters that are restricted to a value be displayed?

sort.alphabetical

Logical. Should parameters be orderd alphabetical? If FALSE (the default), the order of parameters is: 1. free parameters, 2. inequality restricted parameters, 3. equality restricted parameters, 4. fixed.parameters.

...

ignored.

Details

Convenience function that displayes parameter values plus confidence intervals. Parameters that are restricted are marked in the output (1 = fixed parameter, 2 = equality restricted parameter, 3 = inequality restricted parameter).

Value

For a signle fit a data.frame with four columns: estimated parameter values, lower bound of the confidence interval, upper bound of the confidence interval, type of parameter.

For mutliple fits a list with three items. The columns are the same as for single fits.

individual

A 3-dimensional (named) array with the value for each individual, with dimensions: (parameter, column, individual)

mean

mean parameter values

aggregated

values for the aggregated data

Author(s)

Henrik Singmann

See Also

fit.mpt fir the function that returns the necessary object


MPTinR2 documentation built on May 2, 2019, 4:44 p.m.