read_data

Reads either a custom dataframe object or an official Excel file (datalist
or data export) and transforms it to a dataframe object which can be used
for the standard analysis model

Implementation of the Swiss Confederation's standard analysis
model for salary analyses
<https://www.ebg.admin.ch/en/equal-pay-analysis-with-logib> in R. The
analysis is run at company-level and the model is intended for
medium-sized and large companies. It can technically be used with 50
or more employees (apprentices, trainees/interns and expats are not
included in the analysis). Employees with at least 100 employees are
required by the Gender Equality Act to conduct an equal pay analysis.
This package allows users to run the equal salary analysis in R,
providing additional transparency with respect to the methodology and
simple automation possibilities.

Marc Stöckli

logib

Salary Analysis by the Swiss Federal Office for Gender Equality

Jonathan Chassot

Jeremy Kolly

Federal Office for Gender Equality of Switzerland 

read_data function

<dl><dt>data_path</dt>
<dd>a string indicating the path for an official Excel file,
if this parameter is set to <code>NULL</code>, the function reads the dataframe
object provided in the parameter <code>custom_data</code> instead</dd>
<dt>custom_data</dt>
<dd>a dataframe which was imported by the user beforehand,
if this parameter is set to <code>NULL</code>, the function import the data from
the path provided in the parameter <code>data_path</code> instead</dd>
<dt>prompt_mapping</dt>
<dd>a boolean indicating whether the function prompts the
user for the exact mapping of his dataframe or whether the columns are
mapped automatically by order. This parameter is only relevant when
<code>custom_data</code> is not set to <code>NULL</code></dd>
<dt>language</dt>
<dd>a character string representing the language in which the
columns will be displayed during the mapping prompt (<code>"de"</code> or
<code>"fr"</code> or <code>"it"</code> or <code>"en"</code>). This parameter is only relevant
when <code>custom_data</code> is not set to <code>NULL</code></dd></dl>

Arguments

Create the dataframe object used for the standard analysis model — read_data

<dl>

<dt>data_path</dt>
<dd>a string indicating the path for an official Excel file,
if this parameter is set to <code>NULL</code>, the function reads the dataframe
object provided in the parameter <code>custom_data</code> instead</dd>


<dt>custom_data</dt>
<dd>a dataframe which was imported by the user beforehand,
if this parameter is set to <code>NULL</code>, the function import the data from
the path provided in the parameter <code>data_path</code> instead</dd>


<dt>prompt_mapping</dt>
<dd>a boolean indicating whether the function prompts the
user for the exact mapping of his dataframe or whether the columns are
mapped automatically by order. This parameter is only relevant when
<code>custom_data</code> is not set to <code>NULL</code></dd>


<dt>language</dt>
<dd>a character string representing the language in which the
columns will be displayed during the mapping prompt (<code>"de"</code> or
<code>"fr"</code> or <code>"it"</code> or <code>"en"</code>). This parameter is only relevant
when <code>custom_data</code> is not set to <code>NULL</code></dd>

</dl>

read_data: Create the dataframe object used for the standard analysis model

Description

Usage

Value

Arguments

Details