README.md

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

Logib

Introduction

The package logib is an R implementation of the Swiss Confederation's salary analysis tool for assessing equal pay practices (https://www.logib.admin.ch)

Installation

GitHub

In order to install the package from GitHub, use the devtools package:

install.packages("devtools")
devtools::install_github("JLDC/logib")

CRAN

In order to install the latest release from CRAN, use:

install.packages("logib")

Examples

library(logib)

# ------------------------------------------------------------------------------
# Variant 1: Using an official datalist or exportfile

# Indicate path to the pre-filled datalist or exportfile 
# (see 'Further Resources' below)
path_to_my_data <- "path/to/my/datalist_or_exportfile.xlsx"
# Read the data from an official datalist to R
my_data <- read_data(data_path = path_to_my_data)

# ------------------------------------------------------------------------------
# Variant 2: Using a pre-loaded dataframe called 'my_dataframe'

# Read the data from the pre-loaded dataframe
my_data <- read_data(custom_data = my_dataframe)

# ==============================================================================
# Run the analysis and store the results
results <- analysis(data = my_data, reference_month = 8, reference_year = 2020)
# Display the results of the analysis
summary(results)

Further Resources

• Federal Office for Gender Equality's information page on Logib
• Web implementation of the Logib salary equality model
• Methodology
• Official datalists:
  • English
  • German
  • French
  • Italian

logib documentation built on Nov. 21, 2021, 9:08 a.m.