summary.SAEforest: Summarizes an 'SAEforest' object

In krennpa/SAEforest: Mixed Effect Random Forests for Small Area Estimation

Summarizes an 'SAEforest' object

Description

Shows additional information about the data, the SAE model and its components. Information is extracted from a SAEforest object. The returned object is suitable for printing with print.

Usage

## S3 method for class 'SAEforest'
summary(object, ...)

Arguments

object	An object of class SAEforest representing point and MSE estimates. Objects differ depending on the estimation method.
...	Optional additional inputs that are ignored for this method.

Value

An object of class summary.SAEforest including information about the sample and population data, the model fit and random forest specific metrics.

See Also

SAEforestObject

Examples

# Loading data
data("eusilcA_pop")
data("eusilcA_smp")

income <- eusilcA_smp$eqIncome
X_covar <- eusilcA_smp[, -c(1, 16, 17, 18)]

# Example 1:
# Calculating point estimates and discussing basic generic functions

model1 <- SAEforest_model(Y = income, X = X_covar, dName = "district",
                         smp_data = eusilcA_smp, pop_data = eusilcA_pop,
                         num.trees=50, mtry=3)

# SAEforest generics:
summary(model1)

krennpa/SAEforest documentation built on Jan. 30, 2024, 12:31 a.m.