summary.ecoML: Summarizing the Results for the Maximum Likelihood Parametric...
In eco: Ecological Inference in 2x2 Tables

summary.ecoML

R Documentation

Summarizing the Results for the Maximum Likelihood Parametric Model for Ecological Inference in 2x2 Tables

summary method for class eco.

## S3 method for class 'ecoML'
summary(
  object,
  CI = c(2.5, 97.5),
  param = TRUE,
  units = FALSE,
  subset = NULL,
  ...
)

`object`	An output object from `eco`.
`CI`	A vector of lower and upper bounds for the Bayesian credible intervals used to summarize the results. The default is the equal tail 95 percent credible interval.
`param`	Ignored.
`units`	Logical. If `TRUE`, the in-sample predictions for each unit or for a subset of units will be provided. The default value is `FALSE`.
`subset`	A numeric vector indicating the subset of the units whose in-sample predications to be provided when `units` is `TRUE`. The default value is `NULL` where the in-sample predictions for each unit will be provided.
`...`	further arguments passed to or from other methods.

summary.eco yields an object of class summary.eco containing the following elements:

`call`	The call from `eco`.
`sem`	Whether the SEM algorithm was executed, as specified by the user upon calling `ecoML`.
`fix.rho`	Whether the correlation parameter was fixed or allowed to vary, as specified by the user upon calling `ecoML`.
`epsilon`	The convergence threshold specified by the user upon calling `ecoML`.
`n.obs`	The number of units.
`iters.em`	The number iterations the EM algorithm cycled through before convergence or reaching the maximum number of iterations allowed.
`iters.sem`	The number iterations the SEM algorithm cycled through before convergence or reaching the maximum number of iterations allowed.
`loglik`	The final observed log-likelihood.
`rho`	A matrix of `iters.em` rows specifying the correlation parameters at each iteration of the EM algorithm. The number of columns depends on how many correlation parameters exist in the model. Column order is the same as the order of the parameters in `param.table`.
`param.table`	Final estimates of the parameter values for the model. Excludes parameters fixed by the user upon calling `ecoML`. See `ecoML` documentation for order of parameters.
`agg.table`	Aggregate estimates of the marginal means of `W_1` and `W_2`
`agg.wtable`	Aggregate estimates of the marginal means of `W_1` and `W_2` using `X` and `N` as weights.

If units = TRUE, the following elements are also included:

W.table

Unit-level estimates for W_1 and W_2.

This object can be printed by print.summary.eco