hyreg2 (version 1.1.0)

give_class: decode classes by the model

Description

This function can be used to decode the classified classes by the model generated using hyreg2 or hyreg2_het

Usage

give_class(data, model, id_col = NULL)

Value

dataframe of two columns, first column named as provided id_col or "observation" if id_col was not given as an input. second column named "mod_comp" indicating the assigned class for this group or observation

Arguments

data

a dataframe, which was used to estimate the model

model

a flexmix modelobject estimated using hyreg2() or hyreg2_het()

id_col

character-string, name of grouping variable, which must be a column of the provided data. the parameter must be specified, if the provided model was estimated under control for groups

Author

Svenja Elkenkamp & John Grosser

Examples

# estimate a model using simulated_data_norm

### using grouping variable id ####
formula <- y ~  -1 + x1 + x2 + x3 | id
k <- 1
stv <- setNames(c(0.2,0.2,0.2,1,1),c(colnames(simulated_data_norm)[3:5],c("sigma","theta")))
control <- list(iter.max = 1000, verbose = 4)

hyflex_mod <- hyreg2(formula = formula,
                    data =  simulated_data_norm,
                    type =  simulated_data_norm$type,
                    stv = stv,
                    k = k,
                    type_cont = "TTO",
                    type_dich = "DCE_A",
                    opt_method = "L-BFGS-B",
                    control = control,
                    latent = "both",
                    id_col = "id"
)
# use of function give_class
give_class(data = simulated_data_norm,
model = hyflex_mod,
id_col = "id")