Skip to contents

Analyzes a selected metric and returns a box plot by default. Additional options available to return a table with distribution elements.

Usage

create_boxplot(
  data,
  metric,
  hrvar = "Organization",
  mingroup = 5,
  return = "plot"
)

Arguments

data

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

metric

Character string containing the name of the metric, e.g. "Collaboration_hours"

hrvar

String containing the name of the HR Variable by which to split metrics. Defaults to "Organization". To run the analysis on the total instead of splitting by an HR attribute, supply NULL (without quotes).

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:

  • "plot"

  • "table"

See Value for more information.

Value

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

  • "plot": 'ggplot' object. A box plot for the metric.

  • "table": data frame. A summary table for the metric.

Details

This is a general purpose function that powers all the functions in the package that produce box plots.

Examples

# Create a box plot for Collaboration_hours by Level Designation
create_boxplot(pq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation", return = "plot")


# Create a box plot for Collaboration_hours by Organization
create_boxplot(pq_data, metric = "Collaboration_hours", hrvar = "Organization", return = "plot")


# Create a summary statistics table for Collaboration_hoursby Organization
create_boxplot(pq_data, metric = "Collaboration_hours", hrvar = "Organization", return = "table")
#> # A tibble: 4 × 8
#>   group                mean median    sd   min   max range     n
#>   <chr>               <dbl>  <dbl> <dbl> <dbl> <dbl> <dbl> <int>
#> 1 Finance              16.7   13.4 10.4   8.83  54.5  45.7    27
#> 2 HR                   17.8   12.3 23.4   8.99 119.  110.     21
#> 3 Product              11.7   10.8  5.03  8.13  32.5  24.4    21
#> 4 Sales and Marketing  25.8   13.3 27.8   7.08 119.  112.     31