div_parse_paygap: Prepare the paygap matrix to be published in LaTeX

Description Usage Arguments Value Examples

View source: R/div_parse_paygap.R

Description

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

Usage

1
2
3
4
5
6
7
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

1
2
3

div documentation built on May 6, 2021, 9:06 a.m.

Related to div_parse_paygap in div...