This function flags persons who have an unusual ratio of collaboration hours to after-hours collaboration hours. Returns a character string by default.

flag_ch_ratio(data, threshold = c(1, 30), return = "message")

Arguments

data

A data frame containing a Person Query.

threshold

Numeric value specifying the threshold for flagging. Defaults to 30.

return

String to specify what to return. Options include:

  • "message"

  • "text"

  • "data"

Value

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

argument:

  • "message": message in the console containing diagnostic summary

  • "text": string containing diagnotic summary

  • "data": data frame. Person-level data with flags on unusually high or low ratios

Metrics used

The metric Collaboration_hours is used in the calculations. Please ensure that your query contains a metric with the exact same name.

Examples

flag_ch_ratio(sq_data)
#> [Pass] The ratio of after-hours collaboration to total collaboration hours is outside the expected threshold for only 0 employees (0 % of the total).
#> - 0 employees (0 %) have an unusually high after-hours collaboration (relative to weekly collaboration hours)
#> - 0 employees (0 %) have an unusually low after-hours collaboration


data.frame(PersonId = c("Alice", "Bob"),
           Collaboration_hours = c(30, 0.5),
           After_hours_collaboration_hours = c(0.5, 30)) %>%
  flag_ch_ratio()
#> [Warning]  The ratio of after-hours collaboration to total collaboration hours is outside the expected threshold for 2 employees (100 % of the total).
#> - 1 employees (50 %) have an unusually high after-hours collaboration (relative to weekly collaboration hours)
#> - 1 employees (50 %) have an unusually low after-hours collaboration