diff --git a/NAMESPACE b/NAMESPACE index 4d01a73d..bdf4001b 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -4,8 +4,8 @@ export("%>%") export(IV_by_period) export(IV_report) export(afterhours_dist) -export(afterhours_distribution) export(afterhours_fizz) +export(afterhours_line) export(afterhours_rank) export(afterhours_sum) export(afterhours_summary) @@ -118,9 +118,9 @@ export(track_HR_change) export(tstamp) export(validation_report) export(workloads_dist) -export(workloads_distribution) export(workloads_fizz) export(workloads_line) +export(workloads_rank) export(workloads_summary) export(workloads_trend) export(workpatterns_area) diff --git a/R/afterhours_dist.R b/R/afterhours_dist.R index 0f478d32..efaba07b 100644 --- a/R/afterhours_dist.R +++ b/R/afterhours_dist.R @@ -7,6 +7,7 @@ #' #' @details #' Uses the metric \code{After_hours_collaboration_hours}. +#' See `create_dist()` for applying the same analysis to a different metric. #' #' @param data A Standard Person Query dataset in the form of a data frame. #' @param hrvar HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation" @@ -58,7 +59,3 @@ afterhours_dist <- function(data, } - -#' @rdname afterhours_dist -#' @export -afterhours_distribution <- afterhours_dist diff --git a/R/afterhours_fizz.R b/R/afterhours_fizz.R index cad1e4c8..f091573e 100644 --- a/R/afterhours_fizz.R +++ b/R/afterhours_fizz.R @@ -7,10 +7,11 @@ #' #' @details #' Uses the metric `After_hours_collaboration_hours`. +#' See `create_fizz()` for applying the same analysis to a different metric. #' #' @inheritParams create_fizz #' -#' @family Collaboration +#' @family After-Hours #' #' @examples #' afterhours_fizz(sq_data, hrvar = "Organization", return = "table") diff --git a/R/afterhours_line.R b/R/afterhours_line.R new file mode 100644 index 00000000..e139380f --- /dev/null +++ b/R/afterhours_line.R @@ -0,0 +1,57 @@ +#' @title After-hours Collaboration Time Trend - Line Chart +#' +#' @description +#' Provides a week by week view of after-hours collaboration time, visualized as line charts. +#' By default returns a line chart for after-hours collaboration hours, +#' with a separate panel per value in the HR attribute. +#' Additional options available to return a summary table. +#' +#' @details +#' Uses the metric `After_hours_collaboration_hours`. +#' See `create_line()` for applying the same analysis to a different metric. +#' +#' @inheritParams create_line +#' +#' @import dplyr +#' @import ggplot2 +#' @import reshape2 +#' @import scales +#' +#' @family After-Hours +#' +#' @examples +#' +#' ## Return a line plot +#' afterhours_line(sq_data, hrvar = "LevelDesignation") +#' +#' +#' ## Return a table +#' afterhours_line(sq_data, hrvar = "LevelDesignation", return = "table") +#' +#' @return +#' 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. +#' +#' @export + +afterhours_line <- function(data, + hrvar = "Organization", + mingroup=5, + return = "plot"){ + + ## Inherit arguments + output <- create_line(data = data, + metric = "After_hours_collaboration_hours", + hrvar = hrvar, + mingroup = mingroup, + return = return) + + if(return == "plot"){ + output + + labs(title = "After-hours collaboration Hours") + } else if(return == "table"){ + output + } else { + stop("Invalid `return` value") + } +} diff --git a/R/afterhours_rank.R b/R/afterhours_rank.R index 1367eaf0..2db1c85f 100644 --- a/R/afterhours_rank.R +++ b/R/afterhours_rank.R @@ -6,15 +6,9 @@ #' #' @details #' Uses the metric \code{After_hours_collaboration_hours}. +#' See `create_rank()` for applying the same analysis to a different metric. #' -#' @param data A Standard Person Query dataset in the form of a data frame. -#' @param hrvar A list of HR Variables to consider in the scan. -#' Defaults to all HR attributes identified. -#' @param mingroup Numeric value setting the privacy threshold / minimum group size. -#' Defaults to 5. -#' @param return A character vector specifying what to return. -#' Valid values include "html" (default, returning an interactive DataTable) -#' and "df" (data frame) +#' @inheritParams create_rank #' #' @import dplyr #' @import ggplot2 @@ -25,8 +19,7 @@ #' @family After-Hours #' #' @return -#' 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. +#' When 'table' is passed in `return`, a summary table is returned as a data frame. #' #' @export @@ -35,18 +28,9 @@ afterhours_rank <- function(data, mingroup = 5, return = "table"){ - output <- - data %>% + data %>% create_rank(metric = "After_hours_collaboration_hours", hrvar = hrvar, mingroup = mingroup, - return = "table") - - if(return == "html"){ - return(create_dt(output)) - } else if(return == "table"){ - return(output) - } else { - stop("Invalid `return` argument.") - } + return = return) } diff --git a/R/collaboration_rank.R b/R/collaboration_rank.R index 57ebe37f..03c6c007 100644 --- a/R/collaboration_rank.R +++ b/R/collaboration_rank.R @@ -6,27 +6,14 @@ #' #' @details #' Uses the metric `Collaboration_hours`. +#' See `create_rank()` for applying the same analysis to a different metric. #' -#' @param data A Standard Query dataset in the form of a data frame. -#' @param hrvar A list of HR Variables to consider in the scan. -#' Defaults to all HR attributes identified. -#' @param mingroup Numeric value setting the privacy threshold / minimum group size. -#' Defaults to 5. -#' @param return A character vector specifying what to return. -#' Valid values include "html" (default, returning an interactive DataTable) -#' and "df" (data frame) -#' -#' @import dplyr -#' @import ggplot2 -#' @import reshape2 -#' @import scales -#' @importFrom stats reorder +#' @inheritParams create_rank #' #' @family Collaboration #' #' @return -#' 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. +#' When 'table' is passed in `return`, a summary table is returned as a data frame. #' #' @export @@ -35,16 +22,10 @@ collaboration_rank <- function(data, mingroup = 5, return = "table"){ - output <- - data %>% create_rank(metric="Collaboration_hours", hrvar = hrvar, - mingroup = mingroup, - return = "table") + data %>% + create_rank(metric="Collaboration_hours", + hrvar = hrvar, + mingroup = mingroup, + return = return) - if(return == "html"){ - return(create_dt(output)) - } else if(return == "table"){ - return(output) - } else { - stop("Invalid `return` argument.") - } } diff --git a/R/create_bar.R b/R/create_bar.R index ed1ff3e2..4da77ddc 100644 --- a/R/create_bar.R +++ b/R/create_bar.R @@ -5,7 +5,7 @@ #' Returns a bar plot showing the average of a selected metric by default. #' Additional options available to return a summary table. #' -#' @param data A Standard Query dataset in the form of a data frame. +#' @param data A Standard Person Query dataset in the form of a data frame. #' @param metric Character string containing the name of the metric, #' e.g. "Collaboration_hours" #' @param hrvar HR Variable by which to split metrics, defaults to "Organization" diff --git a/R/create_boxplot.R b/R/create_boxplot.R index 7c9bbcdc..75fcac44 100644 --- a/R/create_boxplot.R +++ b/R/create_boxplot.R @@ -8,7 +8,7 @@ #' This is a general purpose function that powers all the functions #' in the package that produce box plots. #' -#' @param data A Standard Query dataset in the form of a data frame. +#' @param data A Standard Person Query dataset in the form of a data frame. #' @param metric Character string containing the name of the metric, #' e.g. "Collaboration_hours" #' @param hrvar HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation" diff --git a/R/create_dist.R b/R/create_dist.R index a64e42c0..7a9398e2 100644 --- a/R/create_dist.R +++ b/R/create_dist.R @@ -5,7 +5,7 @@ #' Returns a stacked bar plot by default. #' Additional options available to return a table with distribution elements. #' -#' @param data A Standard Query dataset in the form of a data frame. +#' @param data A Standard Person Query dataset in the form of a data frame. #' @param metric Character string containing the name of the metric, #' e.g. "Collaboration_hours" #' @param hrvar HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation" diff --git a/R/create_fizz.R b/R/create_fizz.R index bb10f928..472efdc9 100644 --- a/R/create_fizz.R +++ b/R/create_fizz.R @@ -8,7 +8,7 @@ #' This is a general purpose function that powers all the functions #' in the package that produce 'fizzy drink' / jitter scatter plots. #' -#' @param data A Standard Query dataset in the form of a data frame. +#' @param data A Standard Person Query dataset in the form of a data frame. #' @param metric Character string containing the name of the metric, #' e.g. "Collaboration_hours" #' @param hrvar HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation" diff --git a/R/create_line.R b/R/create_line.R index 1603d99a..1350b28d 100644 --- a/R/create_line.R +++ b/R/create_line.R @@ -10,7 +10,7 @@ #' This is a general purpose function that powers all the functions #' in the package that produce faceted line plots. #' -#' @param data A Standard Query dataset in the form of a data frame. +#' @param data A Standard Person Query dataset in the form of a data frame. #' @param metric Character string containing the name of the metric, #' e.g. "Collaboration_hours" #' @param hrvar HR Variable by which to split metrics, defaults to "Organization" diff --git a/R/create_rank.R b/R/create_rank.R index 72a98a1d..7cc022c0 100644 --- a/R/create_rank.R +++ b/R/create_rank.R @@ -1,10 +1,10 @@ -#' @title Create Ranking +#' @title Rank all groups across HR attributes on a selected Workplace Analytics metric #' #' @description -#' This function scans a standard query output for groups with high levels of a given Workplace Analytics Metric. -#' Returns a table with a all of groups (across multiple HR attributes) ranked by the specified metric. +#' This function scans a standard Person query output for groups with high levels of a given Workplace Analytics Metric. +#' Returns a table with all groups (across multiple HR attributes) ranked by the specified metric. #' -#' @param data A Standard Query dataset in the form of a data frame. +#' @param data A Standard Person Query dataset in the form of a data frame. #' @param metric Character string containing the name of the metric, #' e.g. "Collaboration_hours" #' @param hrvar A list of HR Variables to consider in the scan. @@ -12,7 +12,8 @@ #' @param mingroup Numeric value setting the privacy threshold / minimum group size. #' Defaults to 5. #' @param return A character vector specifying what to return. -#' Valid values include "table" (default) and "df" (data frame) +#' Valid values include "table" (default). Features are being considered for alternative return options but are currently +#' unavailable. #' #' @import dplyr #' @import ggplot2 @@ -35,23 +36,26 @@ create_rank <- function(data, return = "table"){ results <- - data %>% create_bar( - metric = metric, - hrvar = hrvar[1], - mingroup = mingroup, - return = return, bar_colour = "default") + create_bar(data, + metric = metric, + hrvar = hrvar[1], + mingroup = mingroup, + return = "table") + ## Create a blank column results$hrvar <- "" + ## Empty table results <- results[0,] - for (p in hrvar) { + ## Loop through each HR attribute supplied in argument + for (p in hrvar) { table1 <- data %>% - create_bar(metric = metric, - hrvar = p, - mingroup = mingroup, - return = "table", bar_colour = "default") + create_bar(metric = metric, + hrvar = p, + mingroup = mingroup, + return = "table") table1$hrvar <- p @@ -59,7 +63,8 @@ create_rank <- function(data, } output <- - results %>% arrange(desc(get(metric))) %>% + results %>% + arrange(desc(get(metric))) %>% select(hrvar, everything()) if(return == "table"){ diff --git a/R/create_scatter.R b/R/create_scatter.R index 4a8ffaec..2bc88f0b 100644 --- a/R/create_scatter.R +++ b/R/create_scatter.R @@ -1,4 +1,4 @@ -#' @title Scatter plot (General Purpose) +#' @title Create a Scatter plot with two selected Workplace Analytics metrics (General Purpose) #' #' @description #' Returns a scatter plot of two selected metrics, using colour to map @@ -10,7 +10,7 @@ #' This is a general purpose function that powers all the functions #' in the package that produce scatter plots. #' -#' @param data A Standard Query dataset in the form of a data frame. +#' @param data A Standard Person Query dataset in the form of a data frame. #' @param metric_x Character string containing the name of the metric, #' e.g. "Collaboration_hours" #' @param metric_y Character string containing the name of the metric, @@ -44,8 +44,8 @@ #' #' @export create_scatter <- function(data, - metric_x = "Internal_network_size", - metric_y = "External_network_size", + metric_x, + metric_y, hrvar = "Organization", mingroup = 5, return = "plot"){ diff --git a/R/email_rank.R b/R/email_rank.R index 8dcbbdb1..ee8416c4 100644 --- a/R/email_rank.R +++ b/R/email_rank.R @@ -4,44 +4,28 @@ #' This function scans a standard query output for groups with high levels of 'Weekly Email Collaboration'. #' Returns a table with a all of groups (across multiple HR attributes) ranked by hours of digital collaboration. #' -#' @param data A Standard Query dataset in the form of a data frame. -#' @param hrvar A list of HR Variables to consider in the scan. -#' Defaults to all HR attributes identified. -#' @param mingroup Numeric value setting the privacy threshold / minimum group size. -#' Defaults to 5. -#' @param return A character vector specifying what to return. -#' Valid values include "html" (default, returning an interactive DataTable) -#' and "df" (data frame) +#' @details +#' Uses the metric `Email_hours`. +#' See `create_rank()` for applying the same analysis to a different metric. #' -#' @import dplyr -#' @import ggplot2 -#' @import reshape2 -#' @import scales -#' @importFrom stats reorder +#' @inheritParams create_rank #' #' @family Emails #' #' @return -#' 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. +#' When 'table' is passed in `return`, a summary table is returned as a data frame. #' #' @export email_rank <- function(data, - hrvar = extract_hr(data), - mingroup = 5, - return = "table"){ + hrvar = extract_hr(data), + mingroup = 5, + return = "table"){ - output <- - data %>% create_rank(metric="Email_hours", hrvar = hrvar, - mingroup = mingroup, - return = "table") + data %>% + create_rank(metric = "Email_hours", + hrvar = hrvar, + mingroup = mingroup, + return = return) - if(return == "html"){ - return(create_dt(output)) - } else if(return == "table"){ - return(output) - } else { - stop("Invalid `return` argument.") - } } diff --git a/R/meeting_rank.R b/R/meeting_rank.R index 7cbf4ddd..0aff4d17 100644 --- a/R/meeting_rank.R +++ b/R/meeting_rank.R @@ -4,44 +4,27 @@ #' This function scans a standard query output for groups with high levels of 'Weekly Email Collaboration'. #' Returns a table with a all of groups (across multiple HR attributes) ranked by hours of digital collaboration. #' -#' @param data A Standard Query dataset in the form of a data frame. -#' @param hrvar A list of HR Variables to consider in the scan. -#' Defaults to all HR attributes identified. -#' @param mingroup Numeric value setting the privacy threshold / minimum group size. -#' Defaults to 5. -#' @param return A character vector specifying what to return. -#' Valid values include "html" (default, returning an interactive DataTable) -#' and "df" (data frame) +#' @details +#' Uses the metric `Meeting_hours`. +#' See `create_rank()` for applying the same analysis to a different metric. #' -#' @import dplyr -#' @import ggplot2 -#' @import reshape2 -#' @import scales -#' @importFrom stats reorder +#' @inheritParams create_rank #' #' @family Meetings #' #' @return -#' 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. +#' When 'table' is passed in `return`, a summary table is returned as a data frame. #' #' @export meeting_rank <- function(data, - hrvar = extract_hr(data), - mingroup = 5, - return = "table"){ + hrvar = extract_hr(data), + mingroup = 5, + return = "table"){ + data %>% + create_rank(metric = "Meeting_hours", + hrvar = hrvar, + mingroup = mingroup, + return = return) - output <- - data %>% create_rank(metric="Meeting_hours", hrvar = hrvar, - mingroup = mingroup, - return = "table") - - if(return == "html"){ - return(create_dt(output)) - } else if(return == "table"){ - return(output) - } else { - stop("Invalid `return` argument.") - } } diff --git a/R/meetingtype_dist.R b/R/meetingtype_dist.R index fa8ac9e4..b1cf1b11 100644 --- a/R/meetingtype_dist.R +++ b/R/meetingtype_dist.R @@ -10,6 +10,8 @@ #' @param hrvar Character string to specify the HR attribute to split the data by. #' Note that this is only applicable if a Collaboration Assessment query is passed to the function. If a Meeting Query #' is passed instead, this argument is ignored. +#' @param mingroup Numeric value setting the privacy threshold / minimum group size. Defaults to 5. +#' Only applicable when using a Collaboration Assessment query. #' @param return Character vector specifying what to return, defaults to "plot". #' Valid inputs are "plot" and "table". #' diff --git a/R/meetingtype_dist_ca.R b/R/meetingtype_dist_ca.R index af23f60e..3a90bdfa 100644 --- a/R/meetingtype_dist_ca.R +++ b/R/meetingtype_dist_ca.R @@ -5,6 +5,7 @@ #' using a Collaboration Assessment Query with core WpA variables as an input. #' #' @param data Meeting Query data frame. Must contain the variables `Attendee` and `DurationHours` +#' @param hrvar Character string to specify the HR attribute to split the data by. #' @param mingroup Numeric value setting the privacy threshold / minimum group size. Defaults to 5. #' @param return Character vector specifying what to return, defaults to "plot". #' Valid inputs are "plot" and "table". diff --git a/R/one2one_rank.R b/R/one2one_rank.R index 3226156d..91d351a9 100644 --- a/R/one2one_rank.R +++ b/R/one2one_rank.R @@ -4,44 +4,28 @@ #' This function scans a standard query output for groups with high levels of 'Manager 1:1 Time'. #' Returns a table with a all of groups (across multiple HR attributes) ranked by hours of digital collaboration. #' -#' @param data A Standard Query dataset in the form of a data frame. -#' @param hrvar A list of HR Variables to consider in the scan. -#' Defaults to all HR attributes identified. -#' @param mingroup Numeric value setting the privacy threshold / minimum group size. -#' Defaults to 5. -#' @param return A character vector specifying what to return. -#' Valid values include "html" (default, returning an interactive DataTable) -#' and "df" (data frame) +#' @details +#' Uses the metric `Meeting_hours_with_manager_1_on_1`. +#' See `create_rank()` for applying the same analysis to a different metric. +#' +#' @inheritParams create_rank #' -#' @import dplyr -#' @import ggplot2 -#' @import reshape2 -#' @import scales -#' @importFrom stats reorder #' #' @family Managerial Relations #' #' @return -#' 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. +#' When 'table' is passed in `return`, a summary table is returned as a data frame. #' #' @export one2one_rank <- function(data, - hrvar = extract_hr(data), - mingroup = 5, - return = "table"){ + hrvar = extract_hr(data), + mingroup = 5, + return = "table"){ - output <- - data %>% create_rank(metric="Meeting_hours_with_manager_1_on_1", hrvar = hrvar, - mingroup = mingroup, - return = "table") - - if(return == "html"){ - return(create_dt(output)) - } else if(return == "table"){ - return(output) - } else { - stop("Invalid `return` argument.") - } + data %>% + create_rank(metric = "Meeting_hours_with_manager_1_on_1", + hrvar = hrvar, + mingroup = mingroup, + return = return) } diff --git a/R/workloads_dist.R b/R/workloads_dist.R index c07c76f4..3b291704 100644 --- a/R/workloads_dist.R +++ b/R/workloads_dist.R @@ -1,11 +1,11 @@ -#' @title Work Week Span distribution +#' @title Distribution of Work Week Span #' #' @description #' Analyze Work Week Span distribution. -#' Returns a a 'fizzy' scatter plot by default. +#' Returns a stacked bar plot by default. #' Additional options available to return a table with distribution elements. #' -#' @inheritParams create_fizz +#' @inheritParams create_dist #' #' @family Workloads #' @@ -13,17 +13,18 @@ #' workloads_dist(sq_data, hrvar = "Organization", return = "table") #' @export -workloads_dist <- function(data, hrvar = "Organization", mingroup = 5, return = "plot") { +workloads_dist <- function(data, + hrvar = "Organization", + mingroup = 5, + return = "plot", + cut = c(15, 30, 45)) { ## Inherit arguments - create_fizz(data = data, + create_dist(data = data, metric = "Workweek_span", hrvar = hrvar, mingroup = mingroup, - return = return) + return = return, + cut = cut) } - -#' @rdname workloads_dist -#' @export -workloads_distribution <- workloads_dist diff --git a/R/workloads_rank.R b/R/workloads_rank.R new file mode 100644 index 00000000..b7d17359 --- /dev/null +++ b/R/workloads_rank.R @@ -0,0 +1,30 @@ +#' @title Rank all groups across HR attributes for Work Week Span +#' +#' @description +#' This function scans a standard query output for groups with high levels of Work Week Span. +#' Returns a table with a all of groups (across multiple HR attributes) ranked by work week span. +#' +#' @details +#' Uses the metric `Workweek_span`. +#' See `create_rank()` for applying the same analysis to a different metric. +#' +#' @inheritParams create_rank +#' +#' @family Workloads +#' +#' @return +#' When 'table' is passed in `return`, a summary table is returned as a data frame. +#' +#' @export + +workloads_rank <- function(data, + hrvar = extract_hr(data), + mingroup = 5, + return = "table"){ + + data %>% + create_rank(metric = "Workweek_span", + hrvar = hrvar, + mingroup = mingroup, + return = return) +} diff --git a/man/afterhours_dist.Rd b/man/afterhours_dist.Rd index 34042ab5..bdccb7c5 100644 --- a/man/afterhours_dist.Rd +++ b/man/afterhours_dist.Rd @@ -2,7 +2,6 @@ % Please edit documentation in R/afterhours_dist.R \name{afterhours_dist} \alias{afterhours_dist} -\alias{afterhours_distribution} \title{After-Hours distribution} \usage{ afterhours_dist( @@ -12,14 +11,6 @@ afterhours_dist( return = "plot", cut = c(1, 2, 3) ) - -afterhours_distribution( - data, - hrvar = "Organization", - mingroup = 5, - return = "plot", - cut = c(1, 2, 3) -) } \arguments{ \item{data}{A Standard Person Query dataset in the form of a data frame.} @@ -42,6 +33,7 @@ Additional options available to return a table with distribution elements. } \details{ Uses the metric \code{After_hours_collaboration_hours}. +See \code{create_dist()} for applying the same analysis to a different metric. } \examples{ \dontrun{ @@ -57,6 +49,8 @@ afterhours_dist(sq_data, hrvar = "LevelDesignation", cut = c(4, 7, 9)) } \seealso{ Other After-Hours: +\code{\link{afterhours_fizz}()}, +\code{\link{afterhours_line}()}, \code{\link{afterhours_rank}()}, \code{\link{afterhours_summary}()}, \code{\link{afterhours_trend}()} diff --git a/man/afterhours_fizz.Rd b/man/afterhours_fizz.Rd index c32036f7..3f091911 100644 --- a/man/afterhours_fizz.Rd +++ b/man/afterhours_fizz.Rd @@ -7,7 +7,7 @@ afterhours_fizz(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} @@ -23,20 +23,17 @@ Additional options available to return a table with distribution elements. } \details{ Uses the metric \code{After_hours_collaboration_hours}. +See \code{create_fizz()} for applying the same analysis to a different metric. } \examples{ afterhours_fizz(sq_data, hrvar = "Organization", return = "table") } \seealso{ -Other Collaboration: -\code{\link{collaboration_area}()}, -\code{\link{collaboration_dist}()}, -\code{\link{collaboration_fizz}()}, -\code{\link{collaboration_line}()}, -\code{\link{collaboration_rank}()}, -\code{\link{collaboration_sum}()}, -\code{\link{collaboration_trend}()}, -\code{\link{create_dist}()}, -\code{\link{meeting_trend}()} +Other After-Hours: +\code{\link{afterhours_dist}()}, +\code{\link{afterhours_line}()}, +\code{\link{afterhours_rank}()}, +\code{\link{afterhours_summary}()}, +\code{\link{afterhours_trend}()} } -\concept{Collaboration} +\concept{After-Hours} diff --git a/man/afterhours_line.Rd b/man/afterhours_line.Rd new file mode 100644 index 00000000..85d9b241 --- /dev/null +++ b/man/afterhours_line.Rd @@ -0,0 +1,52 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/afterhours_line.R +\name{afterhours_line} +\alias{afterhours_line} +\title{After-hours Collaboration Time Trend - Line Chart} +\usage{ +afterhours_line(data, hrvar = "Organization", mingroup = 5, return = "plot") +} +\arguments{ +\item{data}{A Standard Person Query dataset in the form of a data frame.} + +\item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" +but accepts any character vector, e.g. "LevelDesignation"} + +\item{mingroup}{Numeric value setting the privacy threshold / minimum group size. Defaults to 5.} + +\item{return}{Character vector specifying what to return, defaults to "plot". +Valid inputs are "plot" and "table".} +} +\value{ +Returns a ggplot object by default, where 'plot' is passed in \code{return}. +When 'table' is passed, a summary table is returned as a data frame. +} +\description{ +Provides a week by week view of after-hours collaboration time, visualized as line charts. +By default returns a line chart for after-hours collaboration hours, +with a separate panel per value in the HR attribute. +Additional options available to return a summary table. +} +\details{ +Uses the metric \code{After_hours_collaboration_hours}. +See \code{create_line()} for applying the same analysis to a different metric. +} +\examples{ + +## Return a line plot +afterhours_line(sq_data, hrvar = "LevelDesignation") + + +## Return a table +afterhours_line(sq_data, hrvar = "LevelDesignation", return = "table") + +} +\seealso{ +Other After-Hours: +\code{\link{afterhours_dist}()}, +\code{\link{afterhours_fizz}()}, +\code{\link{afterhours_rank}()}, +\code{\link{afterhours_summary}()}, +\code{\link{afterhours_trend}()} +} +\concept{After-Hours} diff --git a/man/afterhours_rank.Rd b/man/afterhours_rank.Rd index 13e7ab24..6af17a57 100644 --- a/man/afterhours_rank.Rd +++ b/man/afterhours_rank.Rd @@ -16,12 +16,11 @@ Defaults to all HR attributes identified.} Defaults to 5.} \item{return}{A character vector specifying what to return. -Valid values include "html" (default, returning an interactive DataTable) -and "df" (data frame)} +Valid values include "table" (default). Features are being considered for alternative return options but are currently +unavailable.} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. -When 'table' is passed, a summary table is returned as a data frame. +When 'table' is passed in \code{return}, a summary table is returned as a data frame. } \description{ This function scans a Standard Person Query for groups with high levels of After-Hours Collaboration. @@ -29,10 +28,13 @@ Returns a table with a all of groups (across multiple HR attributes) ranked by h } \details{ Uses the metric \code{After_hours_collaboration_hours}. +See \code{create_rank()} for applying the same analysis to a different metric. } \seealso{ Other After-Hours: \code{\link{afterhours_dist}()}, +\code{\link{afterhours_fizz}()}, +\code{\link{afterhours_line}()}, \code{\link{afterhours_summary}()}, \code{\link{afterhours_trend}()} } diff --git a/man/afterhours_summary.Rd b/man/afterhours_summary.Rd index bf44f8eb..d9d56f95 100644 --- a/man/afterhours_summary.Rd +++ b/man/afterhours_summary.Rd @@ -10,7 +10,7 @@ afterhours_summary(data, hrvar = "Organization", mingroup = 5, return = "plot") afterhours_sum(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} @@ -42,6 +42,8 @@ afterhours_summary(sq_data, hrvar = "LevelDesignation", return = "table") \seealso{ Other After-Hours: \code{\link{afterhours_dist}()}, +\code{\link{afterhours_fizz}()}, +\code{\link{afterhours_line}()}, \code{\link{afterhours_rank}()}, \code{\link{afterhours_trend}()} } diff --git a/man/afterhours_trend.Rd b/man/afterhours_trend.Rd index 9c41e2cc..77f6ead6 100644 --- a/man/afterhours_trend.Rd +++ b/man/afterhours_trend.Rd @@ -39,6 +39,8 @@ afterhours_trend(sq_data, hrvar = "LevelDesignation", return = "table") \seealso{ Other After-Hours: \code{\link{afterhours_dist}()}, +\code{\link{afterhours_fizz}()}, +\code{\link{afterhours_line}()}, \code{\link{afterhours_rank}()}, \code{\link{afterhours_summary}()} } diff --git a/man/collaboration_area.Rd b/man/collaboration_area.Rd index 0e6cace0..241b4712 100644 --- a/man/collaboration_area.Rd +++ b/man/collaboration_area.Rd @@ -33,7 +33,6 @@ and \code{Instant_Message_hours}. } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_fizz}()}, \code{\link{collaboration_line}()}, diff --git a/man/collaboration_dist.Rd b/man/collaboration_dist.Rd index c766a40a..873027fa 100644 --- a/man/collaboration_dist.Rd +++ b/man/collaboration_dist.Rd @@ -30,7 +30,7 @@ collaboration_distribution( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} @@ -59,7 +59,6 @@ collaboration_dist(sq_data, hrvar = "Organization", return = "table") } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_fizz}()}, \code{\link{collaboration_line}()}, diff --git a/man/collaboration_fizz.Rd b/man/collaboration_fizz.Rd index 40805d72..3e4eddd3 100644 --- a/man/collaboration_fizz.Rd +++ b/man/collaboration_fizz.Rd @@ -7,7 +7,7 @@ collaboration_fizz(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} @@ -29,7 +29,6 @@ collaboration_fizz(sq_data, hrvar = "Organization", return = "table") } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_line}()}, diff --git a/man/collaboration_line.Rd b/man/collaboration_line.Rd index eb533162..c287f7b7 100644 --- a/man/collaboration_line.Rd +++ b/man/collaboration_line.Rd @@ -42,7 +42,6 @@ collaboration_line(sq_data, hrvar = "LevelDesignation", return = "table") } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_fizz}()}, diff --git a/man/collaboration_rank.Rd b/man/collaboration_rank.Rd index 14cdbdf3..071b5c01 100644 --- a/man/collaboration_rank.Rd +++ b/man/collaboration_rank.Rd @@ -12,7 +12,7 @@ collaboration_rank( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{A list of HR Variables to consider in the scan. Defaults to all HR attributes identified.} @@ -21,12 +21,11 @@ Defaults to all HR attributes identified.} Defaults to 5.} \item{return}{A character vector specifying what to return. -Valid values include "html" (default, returning an interactive DataTable) -and "df" (data frame)} +Valid values include "table" (default). Features are being considered for alternative return options but are currently +unavailable.} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. -When 'table' is passed, a summary table is returned as a data frame. +When 'table' is passed in \code{return}, a summary table is returned as a data frame. } \description{ This function scans a standard query output for groups with high levels of 'Weekly Digital Collaboration'. @@ -34,10 +33,10 @@ Returns a table with a all of groups (across multiple HR attributes) ranked by h } \details{ Uses the metric \code{Collaboration_hours}. +See \code{create_rank()} for applying the same analysis to a different metric. } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_fizz}()}, diff --git a/man/collaboration_sum.Rd b/man/collaboration_sum.Rd index ff05e37b..167bfa3a 100644 --- a/man/collaboration_sum.Rd +++ b/man/collaboration_sum.Rd @@ -45,7 +45,6 @@ and \code{Instant_Message_hours}. } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_fizz}()}, diff --git a/man/collaboration_trend.Rd b/man/collaboration_trend.Rd index ed6555a3..2a234946 100644 --- a/man/collaboration_trend.Rd +++ b/man/collaboration_trend.Rd @@ -36,7 +36,6 @@ Uses the metric \code{Collaboration_hours}. } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_fizz}()}, diff --git a/man/create_bar.Rd b/man/create_bar.Rd index 9337f828..65631ac4 100644 --- a/man/create_bar.Rd +++ b/man/create_bar.Rd @@ -15,7 +15,7 @@ create_bar( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{metric}{Character string containing the name of the metric, e.g. "Collaboration_hours"} diff --git a/man/create_boxplot.Rd b/man/create_boxplot.Rd index daf503ff..501c435a 100644 --- a/man/create_boxplot.Rd +++ b/man/create_boxplot.Rd @@ -13,7 +13,7 @@ create_boxplot( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{metric}{Character string containing the name of the metric, e.g. "Collaboration_hours"} diff --git a/man/create_dist.Rd b/man/create_dist.Rd index 445ab3b9..9cabbac8 100644 --- a/man/create_dist.Rd +++ b/man/create_dist.Rd @@ -15,7 +15,7 @@ create_dist( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{metric}{Character string containing the name of the metric, e.g. "Collaboration_hours"} @@ -47,7 +47,6 @@ create_dist(sq_data, metric = "Collaboration_hours", hrvar = "Organization", ret } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_fizz}()}, diff --git a/man/create_fizz.Rd b/man/create_fizz.Rd index 2d60b6c4..dad99a8a 100644 --- a/man/create_fizz.Rd +++ b/man/create_fizz.Rd @@ -13,7 +13,7 @@ create_fizz( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{metric}{Character string containing the name of the metric, e.g. "Collaboration_hours"} diff --git a/man/create_line.Rd b/man/create_line.Rd index cd036a31..ecdd5b2f 100644 --- a/man/create_line.Rd +++ b/man/create_line.Rd @@ -13,7 +13,7 @@ create_line( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{metric}{Character string containing the name of the metric, e.g. "Collaboration_hours"} diff --git a/man/create_rank.Rd b/man/create_rank.Rd index 2422dc7f..6dd0ebd2 100644 --- a/man/create_rank.Rd +++ b/man/create_rank.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/create_rank.R \name{create_rank} \alias{create_rank} -\title{Create Ranking} +\title{Rank all groups across HR attributes on a selected Workplace Analytics metric} \usage{ create_rank( data, @@ -13,7 +13,7 @@ create_rank( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{metric}{Character string containing the name of the metric, e.g. "Collaboration_hours"} @@ -25,15 +25,16 @@ Defaults to all HR attributes identified.} Defaults to 5.} \item{return}{A character vector specifying what to return. -Valid values include "table" (default) and "df" (data frame)} +Valid values include "table" (default). Features are being considered for alternative return options but are currently +unavailable.} } \value{ Returns a ggplot object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ -This function scans a standard query output for groups with high levels of a given Workplace Analytics Metric. -Returns a table with a all of groups (across multiple HR attributes) ranked by the specified metric. +This function scans a standard Person query output for groups with high levels of a given Workplace Analytics Metric. +Returns a table with all groups (across multiple HR attributes) ranked by the specified metric. } \seealso{ Other General: diff --git a/man/create_scatter.Rd b/man/create_scatter.Rd index 8ebe1419..99afab29 100644 --- a/man/create_scatter.Rd +++ b/man/create_scatter.Rd @@ -2,19 +2,19 @@ % Please edit documentation in R/create_scatter.R \name{create_scatter} \alias{create_scatter} -\title{Scatter plot (General Purpose)} +\title{Create a Scatter plot with two selected Workplace Analytics metrics (General Purpose)} \usage{ create_scatter( data, - metric_x = "Internal_network_size", - metric_y = "External_network_size", + metric_x, + metric_y, hrvar = "Organization", mingroup = 5, return = "plot" ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{metric_x}{Character string containing the name of the metric, e.g. "Collaboration_hours"} diff --git a/man/email_dist.Rd b/man/email_dist.Rd index 39fc9b03..0ff9069b 100644 --- a/man/email_dist.Rd +++ b/man/email_dist.Rd @@ -13,7 +13,7 @@ email_dist( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/email_fizz.Rd b/man/email_fizz.Rd index e49ebbec..7a53a103 100644 --- a/man/email_fizz.Rd +++ b/man/email_fizz.Rd @@ -7,7 +7,7 @@ email_fizz(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/email_line.Rd b/man/email_line.Rd index f5fcc937..754d30c9 100644 --- a/man/email_line.Rd +++ b/man/email_line.Rd @@ -7,7 +7,7 @@ email_line(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/email_rank.Rd b/man/email_rank.Rd index 847fd290..cdfd5595 100644 --- a/man/email_rank.Rd +++ b/man/email_rank.Rd @@ -7,7 +7,7 @@ email_rank(data, hrvar = extract_hr(data), mingroup = 5, return = "table") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{A list of HR Variables to consider in the scan. Defaults to all HR attributes identified.} @@ -16,17 +16,20 @@ Defaults to all HR attributes identified.} Defaults to 5.} \item{return}{A character vector specifying what to return. -Valid values include "html" (default, returning an interactive DataTable) -and "df" (data frame)} +Valid values include "table" (default). Features are being considered for alternative return options but are currently +unavailable.} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. -When 'table' is passed, a summary table is returned as a data frame. +When 'table' is passed in \code{return}, a summary table is returned as a data frame. } \description{ This function scans a standard query output for groups with high levels of 'Weekly Email Collaboration'. Returns a table with a all of groups (across multiple HR attributes) ranked by hours of digital collaboration. } +\details{ +Uses the metric \code{Email_hours}. +See \code{create_rank()} for applying the same analysis to a different metric. +} \seealso{ Other Emails: \code{\link{email_dist}()}, diff --git a/man/email_summary.Rd b/man/email_summary.Rd index 483fd96a..9c618ce7 100644 --- a/man/email_summary.Rd +++ b/man/email_summary.Rd @@ -7,7 +7,7 @@ email_summary(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/meeting_dist.Rd b/man/meeting_dist.Rd index 0d556d66..f65b1e19 100644 --- a/man/meeting_dist.Rd +++ b/man/meeting_dist.Rd @@ -22,7 +22,7 @@ meeting_distribution( ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/meeting_fizz.Rd b/man/meeting_fizz.Rd index 3028875c..3f9c9a84 100644 --- a/man/meeting_fizz.Rd +++ b/man/meeting_fizz.Rd @@ -7,7 +7,7 @@ meeting_fizz(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/meeting_line.Rd b/man/meeting_line.Rd index 87532ac1..20c1740f 100644 --- a/man/meeting_line.Rd +++ b/man/meeting_line.Rd @@ -7,7 +7,7 @@ meeting_line(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/meeting_rank.Rd b/man/meeting_rank.Rd index 13162469..584fd3d1 100644 --- a/man/meeting_rank.Rd +++ b/man/meeting_rank.Rd @@ -7,7 +7,7 @@ meeting_rank(data, hrvar = extract_hr(data), mingroup = 5, return = "table") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{A list of HR Variables to consider in the scan. Defaults to all HR attributes identified.} @@ -16,17 +16,20 @@ Defaults to all HR attributes identified.} Defaults to 5.} \item{return}{A character vector specifying what to return. -Valid values include "html" (default, returning an interactive DataTable) -and "df" (data frame)} +Valid values include "table" (default). Features are being considered for alternative return options but are currently +unavailable.} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. -When 'table' is passed, a summary table is returned as a data frame. +When 'table' is passed in \code{return}, a summary table is returned as a data frame. } \description{ This function scans a standard query output for groups with high levels of 'Weekly Email Collaboration'. Returns a table with a all of groups (across multiple HR attributes) ranked by hours of digital collaboration. } +\details{ +Uses the metric \code{Meeting_hours}. +See \code{create_rank()} for applying the same analysis to a different metric. +} \seealso{ Other Meetings: \code{\link{meeting_fizz}()}, diff --git a/man/meeting_summary.Rd b/man/meeting_summary.Rd index 874a808e..d61223be 100644 --- a/man/meeting_summary.Rd +++ b/man/meeting_summary.Rd @@ -7,7 +7,7 @@ meeting_summary(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/meeting_trend.Rd b/man/meeting_trend.Rd index 3682cde2..df6aff7a 100644 --- a/man/meeting_trend.Rd +++ b/man/meeting_trend.Rd @@ -28,7 +28,6 @@ Additional options available to return a summary table. } \seealso{ Other Collaboration: -\code{\link{afterhours_fizz}()}, \code{\link{collaboration_area}()}, \code{\link{collaboration_dist}()}, \code{\link{collaboration_fizz}()}, diff --git a/man/meetingtype_dist.Rd b/man/meetingtype_dist.Rd index b5ea8ec6..37779522 100644 --- a/man/meetingtype_dist.Rd +++ b/man/meetingtype_dist.Rd @@ -13,6 +13,9 @@ meetingtype_dist(data, hrvar = NULL, mingroup = 5, return = "plot") Note that this is only applicable if a Collaboration Assessment query is passed to the function. If a Meeting Query is passed instead, this argument is ignored.} +\item{mingroup}{Numeric value setting the privacy threshold / minimum group size. Defaults to 5. +Only applicable when using a Collaboration Assessment query.} + \item{return}{Character vector specifying what to return, defaults to "plot". Valid inputs are "plot" and "table".} } diff --git a/man/meetingtype_dist_ca.Rd b/man/meetingtype_dist_ca.Rd index 8d19fa52..8ded09a4 100644 --- a/man/meetingtype_dist_ca.Rd +++ b/man/meetingtype_dist_ca.Rd @@ -9,6 +9,8 @@ meetingtype_dist_ca(data, hrvar = NULL, mingroup = 5, return = "plot") \arguments{ \item{data}{Meeting Query data frame. Must contain the variables \code{Attendee} and \code{DurationHours}} +\item{hrvar}{Character string to specify the HR attribute to split the data by.} + \item{mingroup}{Numeric value setting the privacy threshold / minimum group size. Defaults to 5.} \item{return}{Character vector specifying what to return, defaults to "plot". diff --git a/man/one2one_fizz.Rd b/man/one2one_fizz.Rd index e68ed031..5af22aa3 100644 --- a/man/one2one_fizz.Rd +++ b/man/one2one_fizz.Rd @@ -7,7 +7,7 @@ one2one_fizz(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/one2one_rank.Rd b/man/one2one_rank.Rd index 06006ea1..357cea74 100644 --- a/man/one2one_rank.Rd +++ b/man/one2one_rank.Rd @@ -7,7 +7,7 @@ one2one_rank(data, hrvar = extract_hr(data), mingroup = 5, return = "table") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{A list of HR Variables to consider in the scan. Defaults to all HR attributes identified.} @@ -16,17 +16,20 @@ Defaults to all HR attributes identified.} Defaults to 5.} \item{return}{A character vector specifying what to return. -Valid values include "html" (default, returning an interactive DataTable) -and "df" (data frame)} +Valid values include "table" (default). Features are being considered for alternative return options but are currently +unavailable.} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. -When 'table' is passed, a summary table is returned as a data frame. +When 'table' is passed in \code{return}, a summary table is returned as a data frame. } \description{ This function scans a standard query output for groups with high levels of 'Manager 1:1 Time'. Returns a table with a all of groups (across multiple HR attributes) ranked by hours of digital collaboration. } +\details{ +Uses the metric \code{Meeting_hours_with_manager_1_on_1}. +See \code{create_rank()} for applying the same analysis to a different metric. +} \seealso{ Other Managerial Relations: \code{\link{mgrcoatt_dist}()}, diff --git a/man/one2one_sum.Rd b/man/one2one_sum.Rd index a484fbe1..017f4652 100644 --- a/man/one2one_sum.Rd +++ b/man/one2one_sum.Rd @@ -7,7 +7,7 @@ one2one_sum(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} diff --git a/man/workloads_dist.Rd b/man/workloads_dist.Rd index c3b88e81..476edea8 100644 --- a/man/workloads_dist.Rd +++ b/man/workloads_dist.Rd @@ -2,20 +2,18 @@ % Please edit documentation in R/workloads_dist.R \name{workloads_dist} \alias{workloads_dist} -\alias{workloads_distribution} -\title{Work Week Span distribution} +\title{Distribution of Work Week Span} \usage{ -workloads_dist(data, hrvar = "Organization", mingroup = 5, return = "plot") - -workloads_distribution( +workloads_dist( data, hrvar = "Organization", mingroup = 5, - return = "plot" + return = "plot", + cut = c(15, 30, 45) ) } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} @@ -23,10 +21,13 @@ workloads_distribution( \item{return}{Character vector specifying what to return, defaults to "plot". Valid inputs are "plot" and "table".} + +\item{cut}{A numeric vector of length three to specify the breaks for the distribution, +e.g. c(10, 15, 20)} } \description{ Analyze Work Week Span distribution. -Returns a a 'fizzy' scatter plot by default. +Returns a stacked bar plot by default. Additional options available to return a table with distribution elements. } \examples{ @@ -36,6 +37,7 @@ workloads_dist(sq_data, hrvar = "Organization", return = "table") Other Workloads: \code{\link{workloads_fizz}()}, \code{\link{workloads_line}()}, +\code{\link{workloads_rank}()}, \code{\link{workloads_summary}()}, \code{\link{workloads_trend}()} } diff --git a/man/workloads_fizz.Rd b/man/workloads_fizz.Rd index 4eb18180..17c37a38 100644 --- a/man/workloads_fizz.Rd +++ b/man/workloads_fizz.Rd @@ -7,7 +7,7 @@ workloads_fizz(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} @@ -28,6 +28,7 @@ meeting_fizz(sq_data, hrvar = "Organization", return = "table") Other Workloads: \code{\link{workloads_dist}()}, \code{\link{workloads_line}()}, +\code{\link{workloads_rank}()}, \code{\link{workloads_summary}()}, \code{\link{workloads_trend}()} } diff --git a/man/workloads_line.Rd b/man/workloads_line.Rd index a33506bc..2fb4d31e 100644 --- a/man/workloads_line.Rd +++ b/man/workloads_line.Rd @@ -41,6 +41,7 @@ workloads_line(sq_data, hrvar = "LevelDesignation", return = "table") Other Workloads: \code{\link{workloads_dist}()}, \code{\link{workloads_fizz}()}, +\code{\link{workloads_rank}()}, \code{\link{workloads_summary}()}, \code{\link{workloads_trend}()} } diff --git a/man/workloads_rank.Rd b/man/workloads_rank.Rd new file mode 100644 index 00000000..037b36ee --- /dev/null +++ b/man/workloads_rank.Rd @@ -0,0 +1,41 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/workloads_rank.R +\name{workloads_rank} +\alias{workloads_rank} +\title{Rank all groups across HR attributes for Work Week Span} +\usage{ +workloads_rank(data, hrvar = extract_hr(data), mingroup = 5, return = "table") +} +\arguments{ +\item{data}{A Standard Person Query dataset in the form of a data frame.} + +\item{hrvar}{A list of HR Variables to consider in the scan. +Defaults to all HR attributes identified.} + +\item{mingroup}{Numeric value setting the privacy threshold / minimum group size. +Defaults to 5.} + +\item{return}{A character vector specifying what to return. +Valid values include "table" (default). Features are being considered for alternative return options but are currently +unavailable.} +} +\value{ +When 'table' is passed in \code{return}, a summary table is returned as a data frame. +} +\description{ +This function scans a standard query output for groups with high levels of Work Week Span. +Returns a table with a all of groups (across multiple HR attributes) ranked by work week span. +} +\details{ +Uses the metric \code{Workweek_span}. +See \code{create_rank()} for applying the same analysis to a different metric. +} +\seealso{ +Other Workloads: +\code{\link{workloads_dist}()}, +\code{\link{workloads_fizz}()}, +\code{\link{workloads_line}()}, +\code{\link{workloads_summary}()}, +\code{\link{workloads_trend}()} +} +\concept{Workloads} diff --git a/man/workloads_summary.Rd b/man/workloads_summary.Rd index 57a3e38f..1be8427c 100644 --- a/man/workloads_summary.Rd +++ b/man/workloads_summary.Rd @@ -7,7 +7,7 @@ workloads_summary(data, hrvar = "Organization", mingroup = 5, return = "plot") } \arguments{ -\item{data}{A Standard Query dataset in the form of a data frame.} +\item{data}{A Standard Person Query dataset in the form of a data frame.} \item{hrvar}{HR Variable by which to split metrics, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"} @@ -38,6 +38,7 @@ Other Workloads: \code{\link{workloads_dist}()}, \code{\link{workloads_fizz}()}, \code{\link{workloads_line}()}, +\code{\link{workloads_rank}()}, \code{\link{workloads_trend}()} } \concept{Workloads} diff --git a/man/workloads_trend.Rd b/man/workloads_trend.Rd index ff83d72b..8dcfae35 100644 --- a/man/workloads_trend.Rd +++ b/man/workloads_trend.Rd @@ -38,6 +38,7 @@ Other Workloads: \code{\link{workloads_dist}()}, \code{\link{workloads_fizz}()}, \code{\link{workloads_line}()}, +\code{\link{workloads_rank}()}, \code{\link{workloads_summary}()} } \concept{Workloads}