logib (version 0.2.0)

summary.analysis_model: Summary of the Salary Analysis

Description

Summary of an estimated salary analysis object of class analysis_model

Usage

# S3 method for analysis_model
summary(object, ...)

Value

Nothing

Arguments

object

estimated salary analysis object of class analysis_model

...

further arguments passed to or from other methods

Details

summary.analysis_model provides a short summary of the wage analysis according to the Standard Analysis Model. The summary describes the number of records used for the analysis, the Kennedy estimate of the wage difference under otherwise equal circumstances and the summary of the linear regression.

Examples

# Estimate standard analysis model
results <- analysis(data = datalist_example, reference_month = 1,
   reference_year = 2019, usual_weekly_hours = 40, female_spec = "F",
   male_spec = "M", age_spec = "age")

# Show summary of the salary analysis
summary(results)