prepare_data: Prepares a dataframe for the analysis

In JLDC/logib: Salary Analysis by the Swiss Federal Office for Gender Equality

Prepares a dataframe for the analysis

Description

Prepares a dataframe for the analysis in three steps:

• Checks whether sex, age, and entry_date have the correct format and whether their specifications are plausible

• Build the dataframe used for the analysis

• Check each row of the dataframe for correctness and plausibility

Usage

prepare_data(
  data,
  reference_month,
  reference_year,
  usual_weekly_hours,
  female_spec = "F",
  male_spec = "M",
  age_spec = NULL,
  entry_date_spec = NULL
)

Arguments

data	a dataframe object as produced by read_data which is to be used in the analysis
reference_month	a number indicating the reference month of the analysis
reference_year	a number indicating the reference year of the analysis
usual_weekly_hours	an optional numeric representing the usual weekly working hours
female_spec	a string or number indicating the way females are specified in the dataset
male_spec	a string or number indicating the way males are specified in the dataset
age_spec	a string indicating the age specification, can be one of NULL, "age", "birthyear", or "date_of_birth". If this parameter is set to NULL, the function automatically tries to infers the specification
entry_date_spec	a string indicating the entry_date specification, can be one of NULL, "years", "entry_year", or "entry_date". If this parameter is set to NULL, the function automatically tries to infers the specification

Value

a data.frame which has no incorrect rows left and can be used to estimate the standard analysis model

JLDC/logib documentation built on Jan. 12, 2025, 4:13 p.m.