div (version 0.3.1)

div_parse_paygap: Prepare the paygap matrix to be published in LaTeX

Description

This function formats the paygap matrix (created by div_paygap()) and prepares it for printing via the function knitr::kable()

Usage

div_parse_paygap(
  pg,
  label = NULL,
  min_nbr_show = NULL,
  max_length_jobID = 12,
  max_length_colnames = 9
)

Arguments

pg

paygap object as created by div::div_paygap(). This is an S3 object with a specific structure

label

character, the label to be used in the caption of the kable object

min_nbr_show

numeric, if provided then only groups that have more than min_nbr_show employees in both categories (selectedValue and others) will be shown

max_length_jobID

numeric, if provided the maximal length of the column jobID (in characters)

max_length_colnames

numeric, if provided the maximal length of the column names (in characters)

Value

knitr::kable object (for LaTeX)

Examples

# NOT RUN {
d  <- div_fake_team()
pg <- div_paygap(d)
div_parse_paygap(pg)

# }