identify_privacythreshold: Identify groups under privacy threshold

View source: R/identify_privacythreshold.R

identify_privacythresholdR Documentation

Identify groups under privacy threshold

Description

This function scans a standard query output for groups with of employees under the privacy threshold. The method consists in reviewing each individual HR attribute, and count the distinct people within each group.

Usage

identify_privacythreshold(
  data,
  hrvar = extract_hr(data),
  mingroup = 5,
  return = "table"
)

Arguments

data

A Standard Person Query dataset in the form of a data frame.

hrvar

A list of HR Variables to consider in the scan. Defaults to all HR attributes identified.

mingroup

Numeric value setting the privacy threshold / minimum group size. Defaults to 5.

return

String specifying what to return. This must be one of the following strings:

  • "table"

  • "text"

See Value for more information.

Value

A different output is returned depending on the value passed to the return argument:

  • "table": data frame. A summary table of groups that fall below the privacy threshold.

  • "text": string. A diagnostic message.

Returns a ggplot object by default, where 'plot' is passed in return. When 'table' is passed, a summary table is returned as a data frame.

See Also

Other Data Validation: check_query(), extract_hr(), flag_ch_ratio(), flag_em_ratio(), flag_extreme(), flag_outlooktime(), hr_trend(), hrvar_count_all(), hrvar_count(), hrvar_trend(), identify_churn(), identify_holidayweeks(), identify_inactiveweeks(), identify_nkw(), identify_outlier(), identify_query(), identify_shifts_wp(), identify_shifts(), identify_tenure(), remove_outliers(), standardise_pq(), subject_validate_report(), subject_validate(), track_HR_change(), validation_report()

Examples

# Return a summary table
dv_data %>% identify_privacythreshold(return = "table")

# Return a diagnostic message
dv_data %>% identify_privacythreshold(return = "text")


wpa documentation built on Aug. 21, 2023, 5:11 p.m.