saeTrafoObject {saeTrafo}R Documentation

Fitted saeTrafoObject

Description

An object of class saeTrafo that represents point predictions of domain-specific means. Optionally, it also contains corresponding MSE estimates. Objects of these classes have methods for various generic functions. See Details for more information.

Details

Objects of class "saeTrafo" and subclass "NER_Trafo" have the following methods: compare_pred, estimators, plot.saeTrafo, predict.NER, qqnorm.saeTrafo, compare_plot, getData, getGroups, getGroupsFormula, getResponse, plot (for documentation, see plot.saeTrafo), print, qqnorm (for documentation, see qqnorm.saeTrafo) and summary (for documentation, see summaries.saeTrafo), coef (for default documentation, see coef), confint (for default documentation, see confint), family (for default documentation, see family), fitted (for default documentation, see fitted.values), fixef, formula (for default documentation, see formula), getVarCov, intervals, logLik (for default documentation, see logLik), nobs (for default documentation, see nobs), ranef, residuals (for default documentation, see residuals), terms (for default documentation, see terms), vcov (for default documentation, see vcov) sigma (for default documentation, see sigma)

Value

The following components are always included in an saeTrafo object but not always filled:

call

the function call that produced the object.

fixed

for details, see fixed in NER_Trafo.

framework

a list with components that describe the data setup, e.g., number of domains in the sample.

ind

data frame containing estimates for the mean per domain.

method

character returning the method for the estimation approach used to fit the linear mixed model and for the the optimal lambda, in our case "reml".

model

list containing a selection of model components.

MSE

data frame containing MSE estimates corresponding to the mean predictions in ind per domain if MSE is selected in function call. If MSE, MSE is NULL.

transformation

character or list containing information about applied transformation.

transform_param

a list with two elements, optimal_lambda and shift_par, where the first contains the optimal parameter for a transformation with transformation parameter or NULL for no and log transformation and the second the potential shift parameter for the log transformation and NULL for no transformation.

successful_bootstraps

a numeric returning the number of successful bootstraps. If MSE = FALSE in the function call or transformation = "no", successful_bootstraps is NULL.

See Also

NER_Trafo, lme, lmeObject


[Package saeTrafo version 1.0.4 Index]