logib: read_data – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

read_data

Create the dataframe object used for the standard analysis model

Description

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

Usage

read_data(
  data_path = NULL,
  custom_data = NULL,
  prompt_mapping = TRUE,
  language = "de"
)

Arguments

`data_path`	a string indicating the path for an official Excel file, if this parameter is set to `NULL`, the function reads the dataframe object provided in the parameter `custom_data` instead
`custom_data`	a dataframe which was imported by the user beforehand, if this parameter is set to `NULL`, the function import the data from the path provided in the parameter `data_path` instead
`prompt_mapping`	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 `custom_data` is not set to `NULL`
`language`	a character string representing the language in which the columns will be displayed during the mapping prompt (`"de"` or `"fr"` or `"it"` or `"en"`). This parameter is only relevant when `custom_data` is not set to `NULL`

Details

Exactly one of data_path or custom_data must be NULL.

Value

a dataframe which can be used to compute the standard analysis model

logib

Salary Analysis by the Swiss Federal Office for Gender Equality

v0.1.0

GPL-3

Authors

Jonathan Chassot [aut, cre], Jeremy Kolly [ctb], Federal Office for Gender Equality of Switzerland [cph, fnd]

Initial release