docs: adjust function family (#58)

At places, also some cleaning up relating to #31.

R/afterhours_dist.R

@@ -29,7 +29,8 @@
 #' @importFrom stats median
 #' @importFrom stats sd
 #'
-#' @family After-Hours
+#' @family Visualization
+#' @family After-hours Collaboration
 #'
 #' @examples
 #' # Return plot

R/afterhours_fizz.R

@@ -17,7 +17,8 @@
 #' @inheritParams create_fizz
 #' @inherit create_fizz return
 #'
-#' @family After-Hours
+#' @family Visualization
+#' @family After-hours Collaboration
 #'
 #' @examples
 #' # Return plot

R/afterhours_line.R

@@ -19,7 +19,8 @@
 #' @inheritParams create_line
 #' @inherit create_line return
 #'
-#' @family After-Hours
+#' @family Visualization
+#' @family After-hours Collaboration
 #'
 #' @examples
 #' # Return a line plot

R/afterhours_rank.R

@@ -21,7 +21,8 @@
 #' @import scales
 #' @importFrom stats reorder
 #'
-#' @family After-Hours
+#' @family Visualization
+#' @family After-hours Collaboration
 #'
 #' @return
 #' When 'table' is passed in `return`, a summary table is returned as a data frame.

R/afterhours_summary.R

@@ -16,7 +16,8 @@
 #' @inheritParams create_bar
 #' @inherit create_bar return
 #'
-#' @family After-Hours
+#' @family Visualization
+#' @family After-hours Collaboration
 #'
 #' @examples
 #' # Return a ggplot bar chart

R/afterhours_trend.R

@@ -15,7 +15,8 @@
 #'
 #' @inheritParams create_trend
 #'
-#' @family After-Hours
+#' @family Visualization
+#' @family After-hours Collaboration
 #'
 #' @examples
 #' # Run plot

R/collaboration_area.R

@@ -34,6 +34,7 @@
 #' @import reshape2
 #' @import scales
 #'
+#' @family Visualization
 #' @family Collaboration
 #'
 #' @examples

R/collaboration_dist.R

@@ -16,6 +16,7 @@
 #' @inheritParams create_dist
 #' @inherit create_dist return
 #'
+#' @family Visualization
 #' @family Collaboration
 #'
 #' @examples

R/collaboration_fizz.R

@@ -16,6 +16,7 @@
 #' @inheritParams create_fizz
 #' @inherit create_fizz return
 #'
+#' @family Visualization
 #' @family Collaboration
 #'
 #' @examples

R/collaboration_line.R

@@ -17,6 +17,7 @@
 #' @inheritParams create_line
 #' @inherit create_line return
 #'
+#' @family Visualization
 #' @family Collaboration
 #'
 #' @examples

R/collaboration_rank.R

@@ -15,6 +15,7 @@
 #'
 #' @inheritParams create_rank
 #'
+#' @family Visualization
 #' @family Collaboration
 #'
 #' @return

R/collaboration_sum.R

@@ -26,6 +26,7 @@
 #' @import scales
 #' @importFrom stats reorder
 #'
+#' @family Visualization
 #' @family Collaboration
 #'
 #' @return

R/collaboration_trend.R

@@ -15,6 +15,7 @@
 #'
 #' @inheritParams create_trend
 #'
+#' @family Visualization
 #' @family Collaboration
 #'
 #' @return

R/combine_signals.R

@@ -6,19 +6,22 @@
 #' @title Combine signals from the Hourly Collaboration query
 #'
 #' @description
-#' Takes in an Hourly Collaboration Data, and for each hour sums and aggregates the
-#' signals (e.g.`Emails_sent` and `IMs_sent`) in `Signals_sent`. This is an internal
-#' function used in the Working Patterns functions.
+#' Takes in an Hourly Collaboration Data, and for each hour sums and aggregates
+#' the signals (e.g.`Emails_sent` and `IMs_sent`) in `Signals_sent`. This is an
+#' internal function used in the Working Patterns functions.
 #'
-#' @param data Hourly Collaboration query containing signal variables (e.g. `Emails_sent_00_01`)
+#' @param data Hourly Collaboration query containing signal variables (e.g.
+#'   `Emails_sent_00_01`)
 #' @param hr Numeric value between 0 to 23 to iterate through
 #' @param signals Character vector for specifying which signal types to combine.
-#' Defaults to c("Emails_sent", "IMs_sent"). Other valid values include "Unscheduled_calls" and
-#' "Meetings".
+#'   Defaults to `c("Emails_sent", "IMs_sent")`. Other valid values include
+#'   `"Unscheduled_calls"` and `"Meetings"`.
 #'
 #' @details
 #' `combine_signals` uses string matching to aggregate columns.
 #'
+#' @family Support
+#'
 #' @examples
 #' # Demo using simulated variables
 #' sim_data <-

R/copy_df.R

@@ -9,16 +9,22 @@
 #' This is a pipe-optimised function, that feeds into `wpa::export()`,
 #' but can be used as a stand-alone function.
 #'
-#' Based on the original function at https://www.github.com/martinctc/surveytoolbox.
+#' Based on the original function from
+#' https://www.github.com/martinctc/surveytoolbox.
 #'
-#' @param x Data frame to be passed through. Cannot contain list-columns or nested data frames.
-#' @param row.names A logical vector for specifying whether to allow row names. Defaults to FALSE.
-#' @param col.names A logical vector for specifying whether to allow column names. Defaults to FALSE.
+#' @param x Data frame to be passed through. Cannot contain list-columns or
+#'   nested data frames.
+#' @param row.names A logical vector for specifying whether to allow row names.
+#'   Defaults to `FALSE`.
+#' @param col.names A logical vector for specifying whether to allow column
+#'   names. Defaults to `FALSE`.
 #' @param quietly Set this to TRUE to not print data frame on console
 #' @param ... Additional arguments for write.table().
 #'
 #' @importFrom utils write.table
 #'
+#' @family Import and Export
+#'
 #' @export
 
 copy_df <-function(x,

R/create_IV.R

@@ -41,6 +41,7 @@
 #'
 #' @import dplyr
 #'
+#' @family Variable Association
 #' @family Information Value
 #'
 #' @examples

R/create_bar.R

@@ -41,16 +41,23 @@
 #' @importFrom scales wrap_format
 #' @importFrom stats reorder
 #'
-#' @family General
+#' @family Visualization
+#' @family Flexible
 #'
 #' @examples
 #' # Return a ggplot bar chart
 #' create_bar(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation")
-#' create_bar(sq_data, metric = "Generated_workload_email_hours")
-#' create_bar(sq_data, metric = "After_hours_collaboration_hours")
+#'
+#' # Change bar colour
+#' create_bar(sq_data,
+#'            metric = "After_hours_collaboration_hours",
+#'            bar_colour = "alert")
 #'
 #' # Return a summary table
-#' create_bar(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation", return = "table")
+#' create_bar(sq_data,
+#'            metric = "Collaboration_hours",
+#'            hrvar = "LevelDesignation",
+#'            return = "table")
 #' @export
 create_bar <- function(data,
                        metric,

R/create_bar_asis.R

@@ -21,7 +21,7 @@
 #' @param ylab Y-axis label for the plot (group axis)
 #' @param xlab X-axis label of the plot (bar axis).
 #' @param percent Logical value to determine whether to show labels as
-#'   percentage signs. Defaults to FALSE.
+#'   percentage signs. Defaults to `FALSE`.
 #' @param bar_colour String to specify colour to use for bars.
 #' In-built accepted values include "default" (default), "alert" (red), and
 #' "darkblue". Otherwise, hex codes are also accepted. You can also supply
@@ -51,7 +51,28 @@
 #' @import ggplot2
 #' @import dplyr
 #'
-#' @family General
+#' @family Visualization
+#' @family Flexible
+#'
+#' @examples
+#' library(dplyr)
+#'
+#' # Summarise Non-person-average median `Emails_sent`
+#' med_df <-
+#'   sq_data %>%
+#'   group_by(Organization) %>%
+#'   summarise(Emails_sent_median = median(Emails_sent))
+#'
+#' med_df %>%
+#'   create_bar_asis(
+#'     group_var = "Organization",
+#'     bar_var = "Emails_sent_median",
+#'     title = "Median Emails Sent by Organization",
+#'     subtitle = "Person Averaging Not Applied",
+#'     bar_colour = "darkblue",
+#'     caption = extract_date_range(sq_data, return = "text")
+#'   )
+#'
 #'
 #' @export
 create_bar_asis <- function(data,

R/create_boxplot.R

@@ -6,7 +6,7 @@
 #' @title Box Plot for any metric
 #'
 #' @description
-#' Analyzes a selected metric and returns a a 'fizzy' scatter plot by default.
+#' Analyzes a selected metric and returns a box plot by default.
 #' Additional options available to return a table with distribution elements.
 #'
 #' @details
@@ -16,9 +16,13 @@
 #' @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"
-#' @param mingroup Numeric value setting the privacy threshold / minimum group size, defaults to 5.
-#' @param return String specifying what to return. This must be one of the following strings:
+#' @param hrvar HR Variable by which to split metrics. Accepts a character
+#'   vector, defaults to "Organization" but accepts any character vector, e.g.
+#'   "LevelDesignation"
+#' @param mingroup Numeric value setting the privacy threshold / minimum group
+#'   size, defaults to 5.
+#' @param return String specifying what to return. This must be one of the
+#'   following strings:
 #'   - `"plot"`
 #'   - `"table"`
 #'
@@ -36,7 +40,8 @@
 #' @importFrom stats median
 #' @importFrom stats sd
 #'
-#' @family General
+#' @family Visualization
+#' @family Flexible
 #'
 #' @examples
 #' # Create a fizzy plot for Work Week Span by Level Designation

R/create_bubble.R

@@ -33,7 +33,8 @@
 #' @import ggplot2
 #' @import scales
 #'
-#' @family General
+#' @family Visualization
+#' @family Flexible
 #'
 #' @examples
 #' create_bubble(sq_data,

R/create_dist.R

@@ -25,7 +25,8 @@
 #'
 #' See `Value` for more information.
 #'
-#' @param cut A numeric vector of length three to specify the breaks for the distribution,
+#' @param cut A numeric vector of length three to specify the breaks for the
+#'   distribution,
 #' e.g. c(10, 15, 20)
 #' @param dist_colours A character vector of length four to specify colour
 #' codes for the stacked bars.
@@ -45,6 +46,7 @@
 #' @importFrom stats median
 #' @importFrom stats sd
 #'
+#' @family Visualization
 #' @family Flexible
 #'
 #' @examples

R/create_dt.R

@@ -16,6 +16,8 @@
 #' @import DT
 #' @importFrom dplyr mutate_if
 #'
+#' @family Import and Export
+#'
 #' @export
 create_dt <- function(x, rounding = 1, freeze = 2){
 

R/create_fizz.R

@@ -36,6 +36,7 @@
 #' @importFrom stats median
 #' @importFrom stats sd
 #'
+#' @family Visualization
 #' @family Flexible
 #'
 #' @examples

R/create_line.R

@@ -33,7 +33,9 @@
 #' @import scales
 #' @importFrom tidyselect all_of
 #'
+#' @family Visualization
 #' @family Flexible
+#' @family Time-series
 #'
 #' @examples
 #' # Return plot of Email Hours

R/create_line_asis.R

@@ -26,7 +26,28 @@
 #' @import ggplot2
 #' @import dplyr
 #'
+#' @family Visualization
 #' @family Flexible
+#' @family Time-series
+#'
+#' @examples
+#' library(dplyr)
+#'
+#' # Median `Emails_sent` grouped by `Date`
+#' # Without Person Averaging
+#' med_df <-
+#'   sq_data %>%
+#'   group_by(Date) %>%
+#'   summarise(Emails_sent_median = median(Emails_sent))
+#'
+#' med_df %>%
+#'   create_line_asis(
+#'     date_var = "Date",
+#'     metric = "Emails_sent_median",
+#'     title = "Median Emails Sent",
+#'     subtitle = "Person Averaging Not Applied",
+#'     caption = extract_date_range(sq_data, return = "text")
+#'   )
 #'
 #' @export
 create_line_asis <- function(data,

R/create_period_scatter.R

@@ -36,7 +36,9 @@
 #' @import dplyr
 #' @import ggplot2
 #'
+#' @family Visualization
 #' @family Flexible
+#' @family Time-series
 #'
 #' @examples
 #' # Return plot

R/create_rank.R

@@ -6,8 +6,9 @@
 #' @title Rank all groups across HR attributes on a selected Workplace Analytics metric
 #'
 #' @description
-#' 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.
+#' 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 Person Query dataset in the form of a data frame.
 #' @param metric Character string containing the name of the metric,
@@ -16,12 +17,18 @@
 #' 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 "table" (default). Features are being considered for alternative return options but are currently
-#' unavailable.
-#' @param plot_mode Numeric vector to determine which plot mode to return:
-#'   1. Top and bottom five groups across the data population are highlighted
-#'   2. Top and bottom groups _per_ organizational attribute are highlighted
+#'
+#' @param return String specifying what to return. This must be one of the
+#'   following strings:
+#'   - `"table"` (default)
+#'   - `"plot"`
+#'
+#' See `Value` for more information.
+#'
+#' @param plot_mode Numeric vector to determine which plot mode to return. Must
+#' be either `1` or `2`, and is only used when `return = "plot"`.
+#'   - `1`: Top and bottom five groups across the data population are highlighted
+#'   - `2`: Top and bottom groups _per_ organizational attribute are highlighted
 #'
 #' @import dplyr
 #' @import ggplot2
@@ -29,11 +36,43 @@
 #' @import scales
 #' @importFrom stats reorder
 #'
+#' @family Visualization
 #' @family Flexible
 #'
+#' @examples
+# Plot mode 1 - show top and bottom five groups
+#' create_rank(
+#'   data = sq_data,
+#'   hrvar = c("FunctionType", "LevelDesignation"),
+#'   metric = "Emails_sent",
+#'   return = "plot",
+#'   plot_mode = 1
+#' )
+#'
+#' # Plot mode 2 - show top and bottom groups per HR variable
+#' create_rank(
+#'   data = sq_data,
+#'   hrvar = c("FunctionType", "LevelDesignation"),
+#'   metric = "Emails_sent",
+#'   return = "plot",
+#'   plot_mode = 2
+#' )
+#'
+#' # Return a table
+#' create_rank(
+#'   data = sq_data,
+#'   metric = "Emails_sent",
+#'   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.
+#' A different output is returned depending on the value passed to the `return`
+#' argument:
+#'   - `"plot"`: ggplot object. A bubble plot where the x-axis represents the
+#'   metric, the y-axis represents the HR attributes, and the size of the
+#'   bubbles represent the size of the organizations.
+#'   - `"table"`: data frame. A summary table for the metric.
 #'
 #' @export
 

R/create_sankey.R

@@ -6,7 +6,7 @@
 #' @title Create a sankey chart from a two-column count table
 #'
 #' @description
-#' Create a networkD3 style sankey chart based on a long count table
+#' Create a 'networkD3' style sankey chart based on a long count table
 #' with two variables. The input data should have three columns, where
 #' each row is a unique group:
 #'   1. Variable 1
@@ -14,12 +14,18 @@
 #'   3. Count
 #'
 #' @param data Data frame of the long count table.
-#' @param var1 String containing the name of the variable to be shown on the left.
-#' @param var2 String containing the name of the variable to be shown on the right.
+#' @param var1 String containing the name of the variable to be shown on the
+#'   left.
+#' @param var2 String containing the name of the variable to be shown on the
+#'   right.
 #' @param count String containing the name of the count variable.
 #'
 #' @import dplyr
 #'
+#' @return A 'sankeyNetwork' and 'htmlwidget' object containing a two-tier
+#'  sankey plot. The output can be saved locally with
+#'  `htmlwidgets::saveWidget()`.
+#'
 #' @examples
 #' \donttest{
 #' sq_data %>%
@@ -27,6 +33,9 @@
 #'   create_sankey(var1 = "Organization", var2 = "FunctionType")
 #' }
 #'
+#' @family Visualization
+#' @family Flexible
+#'
 #' @export
 create_sankey <- function(data, var1, var2, count = "n"){
 

R/create_scatter.R

@@ -30,7 +30,8 @@
 #' @import ggplot2
 #' @import scales
 #'
-#' @family General
+#' @family Visualization
+#' @family Flexible
 #'
 #' @examples
 #' create_scatter(sq_data,

R/create_stacked.R

@@ -7,8 +7,8 @@
 #'
 #' @description
 #' Creates a sum total calculation using selected metrics,
-#' where the typical use case is to create different definitions
-#' of collaboration hours.
+#' where the typical use case is to create different definitions of
+#' collaboration hours.
 #' Returns a stacked bar plot by default.
 #' Additional options available to return a summary table.
 #'
@@ -32,6 +32,7 @@
 #' @import scales
 #' @importFrom stats reorder
 #'
+#' @family Visualization
 #' @family Flexible
 #'
 #' @return

R/create_trend.R

@@ -6,9 +6,10 @@
 #' @title Heat mapped horizontal bar plot over time for any metric
 #'
 #' @description
-#' Provides a week by week view of a selected Workplace Analytics metric.
-#' By default returns a week by week heatmap bar plot, highlighting the points in time with most activity.
-#' Additional options available to return a summary table.
+#' Provides a week by week view of a selected Workplace Analytics metric. By
+#' default returns a week by week heatmap bar plot, highlighting the points in
+#' time with most activity. Additional options available to return a summary
+#' table.
 #'
 #'
 #' @param data A Standard Person Query dataset in the form of a data frame.
@@ -25,7 +26,9 @@
 #' @import reshape2
 #' @import scales
 #'
+#' @family Visualization
 #' @family Flexible
+#' @family Time-series
 #'
 #' @examples
 #' create_trend(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation")

R/cut_hour.R

@@ -9,12 +9,15 @@
 #' Supply a numeric variable, e.g. `Collaboration_hours`,
 #' and the function returns a character vector
 #'
+#' @details
+#' This is used within `create_dist()` for numeric to categorical conversion.
+#'
 #' @param metric A numeric variable representing hours.
 #' @param cuts A numeric variable of minimum length 3 to represent the
 #' cut points required.
 #' @param unit String to specify the unit of the labels. Defaults to "hours".
 #'
-#' @family General
+#' @family Support
 #'
 #' @examples
 #' # Direct use

R/dv_data.R

@@ -6,7 +6,9 @@
 #' @title Sample Standard Person Query dataset for Data Validation
 #'
 #' @description
-#' A dataset generated from a Standard Person Query from WpA.
+#' A dataset generated from a Standard Person Query from Workplace Analytics.
+#'
+#' @family Data
 #'
 #' @format A data frame with 897 rows and 69 variables:
 #' \describe{

R/em_data.R

@@ -6,10 +6,12 @@
 #' @title Sample Hourly Collaboration data with Email and IMs
 #'
 #' @description
-#' A sample dataset generated from an Hourly Collaboration query
-#' from the WpA demo tenant. The data is grouped by week and contains
+#' A sample dataset generated from an Hourly Collaboration query from the
+#' Workplace Analytics demo tenant. The data is grouped by week and contains
 #' columns for both IMs sent and Emails sent.
 #'
+#' @family Data
+#'
 #' @format A data frame with 41567 rows and 56 variables:
 #' \describe{
 #'   \item{PersonId}{ }

R/email_dist.R

@@ -13,6 +13,7 @@
 #' @inheritParams create_dist
 #' @inherit create_dist return
 #'
+#' @family Visualization
 #' @family Emails
 #'
 #' @examples

R/email_fizz.R

@@ -8,6 +8,7 @@
 #' @inheritParams create_fizz
 #' @inherit create_fizz return
 #'
+#' @family Visualization
 #' @family Emails
 #'
 #' @examples

R/email_line.R

@@ -14,6 +14,7 @@
 #' @inheritParams create_line
 #' @inherit create_line return
 #'
+#' @family Visualization
 #' @family Emails
 #'
 #' @examples

R/email_rank.R

@@ -6,20 +6,20 @@
 #' @title Email Hours Ranking
 #'
 #' @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.
+#' 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 `Email_hours`.
 #' See `create_rank()` for applying the same analysis to a different metric.
 #'
 #' @inheritParams create_rank
+#' @inherit create_rank return
 #'
+#' @family Visualization
 #' @family Emails
 #'
-#' @return
-#' When 'table' is passed in `return`, a summary table is returned as a data frame.
-#'
 #' @export
 
 email_rank <- function(data,

R/email_summary.R

@@ -13,6 +13,7 @@
 #' @inheritParams create_bar
 #' @inherit create_bar return
 #'
+#' @family Visualization
 #' @family Emails
 #'
 #' @examples
@@ -25,9 +26,10 @@
 #' @export
 
 email_summary <- function(data,
-                              hrvar = "Organization",
-                              mingroup = 5,
-                              return = "plot"){
+                          hrvar = "Organization",
+                          mingroup = 5,
+                          return = "plot"){
+
   create_bar(data = data,
              metric = "Email_hours",
              hrvar = hrvar,

R/email_trend.R

@@ -13,12 +13,11 @@
 #' Uses the metric `Email_hours`.
 #'
 #' @inheritParams create_trend
+#' @inherit create_trend return
 #'
+#' @family Visualization
 #' @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.
 #'
 #' @export
 

R/export.R

@@ -13,15 +13,34 @@
 #'
 #' @param x Data frame or ggplot object to be passed through.
 #' @param method Character string specifying the method of export.
-#' Valid inputs include "clipboard" (default), "csv", "png", "svg", "jpeg", and "pdf".
-#' @param path If exporting a file, enter the path and the desired file name, _excluding the file extension_.
-#' For example, "Analysis/SQ Overview".
-#' @param timestamp Logical vector specifying whether to include a timestamp in the file name. Defaults to TRUE.
+#' Valid inputs include:
+#'   - `"clipboard"` (default if input is data frame)
+#'   - `"csv"`
+#'   - `"png"` (default if input is ggplot object)
+#'   - `"svg"`
+#'   - `"jpeg"`
+#'   - `"pdf"`
+#' @param path If exporting a file, enter the path and the desired file name,
+#'   _excluding the file extension_. For example, "Analysis/SQ Overview".
+#' @param timestamp Logical vector specifying whether to include a timestamp in
+#'   the file name. Defaults to `TRUE`.
 #' @param width Width of the plot
 #' @param height Height of the plot
 #'
+#' @return
+#' A different output is returned depending on the value passed to the `method`
+#' argument:
+#'   - `"clipboard"`: no return - data frame is saved to clipboard.
+#'   - `"csv"`: CSV file containing data frame is saved to specified path.
+#'   - `"png"`: PNG file containing ggplot object is saved to specified path.
+#'   - `"svg"`: SVG file containing ggplot object is saved to specified path.
+#'   - `"jpeg"`: JPEG file containing ggplot object is saved to specified path.
+#'   - `"pdf"`: PDF file containing ggplot object is saved to specified path.
+#'
 #' @importFrom utils write.csv
 #'
+#' @family Import and Export
+#'
 #' @export
 
 export <- function(x,

R/hrvar_count.R

@@ -32,7 +32,7 @@
 #' @import dplyr
 #' @importFrom data.table ":=" "%like%" "%between%"
 #'
-#' @family General
+#' @family Visualization
 #' @family Data Validation
 #'
 #' @examples

R/supporting_functions.R

@@ -16,10 +16,11 @@
 #' The default value is "stop". Also accepts "names" and "warning".
 #'
 #'
-#' @return The default behaviour is to return an error message,
-#' informing the user what variables are not included. When `return` is set
-#' to "names", a character vector containing the unmatched variable names
-#' is returned.
+#' @return The default behaviour is to return an error message, informing the
+#'   user what variables are not included. When `return` is set to "names", a
+#'   character vector containing the unmatched variable names is returned.
+#'
+#' @param Support
 #'
 #' @examples
 #'
@@ -86,6 +87,8 @@ check_inputs <- function(input, requirements, return = "stop"){
 #'
 #' @param string A string vector in 'CamelCase' format to format
 #'
+#' @family Support
+#'
 #' @examples
 #' camel_clean("NoteHowTheStringIsFormatted")
 #'
@@ -100,6 +103,8 @@ camel_clean <- function(string){
 #'
 #' @param r,g,b Values that correspond to the three RGB parameters
 #'
+#' @family Support
+#'
 #' @export
 rgb2hex <- function(r,g,b){
   grDevices::rgb(r, g, b, maxColorValue = 255)
@@ -120,6 +125,8 @@ rgb2hex <- function(r,g,b){
 #' Returns a table by default ("table"), but allows returning
 #' a descriptive string ("text").
 #'
+#' @family Support
+#'
 #' @export
 extract_date_range <- function(data, return = "table"){
 

man/IV_by_period.Rd

@@ -1,5 +1,5 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/IV_by_period.R
+% Please edit documentation in R/IV_by_Period.R
 \name{IV_by_period}
 \alias{IV_by_period}
 \title{Identify the WPA metrics that have the biggest change between two periods.}

man/afterhours_dist.Rd

@@ -61,11 +61,47 @@ afterhours_dist(sq_data, hrvar = "Organization", return = "table")
 afterhours_dist(sq_data, hrvar = "LevelDesignation", cut = c(4, 7, 9))
 }
 \seealso{
-Other After-Hours: 
+Other Visualization: 
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other After-hours Collaboration: 
 \code{\link{afterhours_fizz}()},
 \code{\link{afterhours_line}()},
 \code{\link{afterhours_rank}()},
 \code{\link{afterhours_summary}()},
 \code{\link{afterhours_trend}()}
 }
-\concept{After-Hours}
+\concept{After-hours Collaboration}
+\concept{Visualization}

man/afterhours_fizz.Rd

@@ -45,11 +45,47 @@ afterhours_fizz(sq_data, hrvar = "LevelDesignation", return = "plot")
 afterhours_fizz(sq_data, hrvar = "Organization", return = "table")
 }
 \seealso{
-Other After-Hours: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other After-hours Collaboration: 
 \code{\link{afterhours_dist}()},
 \code{\link{afterhours_line}()},
 \code{\link{afterhours_rank}()},
 \code{\link{afterhours_summary}()},
 \code{\link{afterhours_trend}()}
 }
-\concept{After-Hours}
+\concept{After-hours Collaboration}
+\concept{Visualization}

man/afterhours_line.Rd

@@ -49,11 +49,47 @@ afterhours_line(sq_data, hrvar = "LevelDesignation", return = "table")
 \seealso{
 \code{\link[=create_line]{create_line()}} for applying the same analysis to a different metric.
 
-Other After-Hours: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other After-hours Collaboration: 
 \code{\link{afterhours_dist}()},
 \code{\link{afterhours_fizz}()},
 \code{\link{afterhours_rank}()},
 \code{\link{afterhours_summary}()},
 \code{\link{afterhours_trend}()}
 }
-\concept{After-Hours}
+\concept{After-hours Collaboration}
+\concept{Visualization}

man/afterhours_rank.Rd

@@ -15,9 +15,14 @@ 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.}
+\item{return}{String specifying what to return. This must be one of the
+following strings:
+\itemize{
+\item \code{"table"} (default)
+\item \code{"plot"}
+}
+
+See \code{Value} for more information.}
 }
 \value{
 When 'table' is passed in \code{return}, a summary table is returned as a data frame.
@@ -31,11 +36,47 @@ 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: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other After-hours Collaboration: 
 \code{\link{afterhours_dist}()},
 \code{\link{afterhours_fizz}()},
 \code{\link{afterhours_line}()},
 \code{\link{afterhours_summary}()},
 \code{\link{afterhours_trend}()}
 }
-\concept{After-Hours}
+\concept{After-hours Collaboration}
+\concept{Visualization}

man/afterhours_summary.Rd

@@ -49,11 +49,47 @@ afterhours_summary(sq_data, hrvar = "LevelDesignation", return = "table")
 
 }
 \seealso{
-Other After-Hours: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other After-hours Collaboration: 
 \code{\link{afterhours_dist}()},
 \code{\link{afterhours_fizz}()},
 \code{\link{afterhours_line}()},
 \code{\link{afterhours_rank}()},
 \code{\link{afterhours_trend}()}
 }
-\concept{After-Hours}
+\concept{After-hours Collaboration}
+\concept{Visualization}

man/afterhours_trend.Rd

@@ -38,11 +38,47 @@ afterhours_trend(sq_data, hrvar = "LevelDesignation", return = "table")
 
 }
 \seealso{
-Other After-Hours: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other After-hours Collaboration: 
 \code{\link{afterhours_dist}()},
 \code{\link{afterhours_fizz}()},
 \code{\link{afterhours_line}()},
 \code{\link{afterhours_rank}()},
 \code{\link{afterhours_summary}()}
 }
-\concept{After-Hours}
+\concept{After-hours Collaboration}
+\concept{Visualization}

man/camel_clean.Rd

@@ -19,3 +19,11 @@ of prettifying plot labels.
 camel_clean("NoteHowTheStringIsFormatted")
 
 }
+\seealso{
+Other Support: 
+\code{\link{combine_signals}()},
+\code{\link{cut_hour}()},
+\code{\link{extract_date_range}()},
+\code{\link{rgb2hex}()}
+}
+\concept{Support}

man/check_inputs.Rd

@@ -13,12 +13,13 @@ check_inputs(input, requirements, return = "stop")
 
 \item{return}{A character string specifying what to return.
 The default value is "stop". Also accepts "names" and "warning".}
+
+\item{Support}{}
 }
 \value{
-The default behaviour is to return an error message,
-informing the user what variables are not included. When \code{return} is set
-to "names", a character vector containing the unmatched variable names
-is returned.
+The default behaviour is to return an error message, informing the
+user what variables are not included. When \code{return} is set to "names", a
+character vector containing the unmatched variable names is returned.
 }
 \description{
 Checks whether a data frame contains all the required variables.

man/collaboration_area.Rd

@@ -58,6 +58,41 @@ collaboration_area(sq_data, return = "table")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Collaboration: 
 \code{\link{collaboration_dist}()},
 \code{\link{collaboration_fizz}()},
@@ -67,3 +102,4 @@ Other Collaboration:
 \code{\link{collaboration_trend}()}
 }
 \concept{Collaboration}
+\concept{Visualization}

man/collaboration_dist.Rd

@@ -39,7 +39,8 @@ size, defaults to 5.}
 
 See \code{Value} for more information.}
 
-\item{cut}{A numeric vector of length three to specify the breaks for the distribution,
+\item{cut}{A numeric vector of length three to specify the breaks for the
+distribution,
 e.g. c(10, 15, 20)}
 }
 \value{
@@ -65,6 +66,41 @@ collaboration_dist(sq_data, hrvar = "Organization")
 collaboration_dist(sq_data, hrvar = "Organization", return = "table")
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\code{\link{collaboration_area}()},
+\code{\link{collaboration_fizz}()},
+\code{\link{collaboration_line}()},
+\code{\link{collaboration_rank}()},
+\code{\link{collaboration_sum}()},
+\code{\link{collaboration_trend}()},
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Collaboration: 
 \code{\link{collaboration_area}()},
 \code{\link{collaboration_fizz}()},
@@ -74,3 +110,4 @@ Other Collaboration:
 \code{\link{collaboration_trend}()}
 }
 \concept{Collaboration}
+\concept{Visualization}

man/collaboration_fizz.Rd

@@ -48,6 +48,41 @@ collaboration_fizz(sq_data, hrvar = "Organization", return = "table")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\code{\link{collaboration_area}()},
+\code{\link{collaboration_dist}()},
+\code{\link{collaboration_line}()},
+\code{\link{collaboration_rank}()},
+\code{\link{collaboration_sum}()},
+\code{\link{collaboration_trend}()},
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Collaboration: 
 \code{\link{collaboration_area}()},
 \code{\link{collaboration_dist}()},
@@ -57,3 +92,4 @@ Other Collaboration:
 \code{\link{collaboration_trend}()}
 }
 \concept{Collaboration}
+\concept{Visualization}

man/collaboration_line.Rd

@@ -50,6 +50,41 @@ collaboration_line(sq_data, hrvar = "LevelDesignation", return = "table")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\code{\link{collaboration_area}()},
+\code{\link{collaboration_dist}()},
+\code{\link{collaboration_fizz}()},
+\code{\link{collaboration_rank}()},
+\code{\link{collaboration_sum}()},
+\code{\link{collaboration_trend}()},
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Collaboration: 
 \code{\link{collaboration_area}()},
 \code{\link{collaboration_dist}()},
@@ -59,3 +94,4 @@ Other Collaboration:
 \code{\link{collaboration_trend}()}
 }
 \concept{Collaboration}
+\concept{Visualization}

man/collaboration_rank.Rd

@@ -23,9 +23,14 @@ 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.}
+\item{return}{String specifying what to return. This must be one of the
+following strings:
+\itemize{
+\item \code{"table"} (default)
+\item \code{"plot"}
+}
+
+See \code{Value} for more information.}
 }
 \value{
 When 'table' is passed in \code{return}, a summary table is returned as a data frame.
@@ -39,6 +44,41 @@ Uses the metric \code{Collaboration_hours}.
 See \code{create_rank()} for applying the same analysis to a different metric.
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\code{\link{collaboration_area}()},
+\code{\link{collaboration_dist}()},
+\code{\link{collaboration_fizz}()},
+\code{\link{collaboration_line}()},
+\code{\link{collaboration_sum}()},
+\code{\link{collaboration_trend}()},
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Collaboration: 
 \code{\link{collaboration_area}()},
 \code{\link{collaboration_dist}()},
@@ -48,3 +88,4 @@ Other Collaboration:
 \code{\link{collaboration_trend}()}
 }
 \concept{Collaboration}
+\concept{Visualization}

man/collaboration_sum.Rd

@@ -44,6 +44,41 @@ Uses the metrics \code{Meeting_hours}, \code{Email_hours}, \code{Unscheduled_Cal
 and \code{Instant_Message_hours}.
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\code{\link{collaboration_area}()},
+\code{\link{collaboration_dist}()},
+\code{\link{collaboration_fizz}()},
+\code{\link{collaboration_line}()},
+\code{\link{collaboration_rank}()},
+\code{\link{collaboration_trend}()},
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Collaboration: 
 \code{\link{collaboration_area}()},
 \code{\link{collaboration_dist}()},
@@ -53,3 +88,4 @@ Other Collaboration:
 \code{\link{collaboration_trend}()}
 }
 \concept{Collaboration}
+\concept{Visualization}

man/collaboration_trend.Rd

@@ -35,6 +35,41 @@ Additional options available to return a summary table.
 Uses the metric \code{Collaboration_hours}.
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Collaboration: 
 \code{\link{collaboration_area}()},
 \code{\link{collaboration_dist}()},
@@ -44,3 +79,4 @@ Other Collaboration:
 \code{\link{collaboration_sum}()}
 }
 \concept{Collaboration}
+\concept{Visualization}

man/combine_signals.Rd

@@ -7,18 +7,19 @@
 combine_signals(data, hr, signals = c("Emails_sent", "IMs_sent"))
 }
 \arguments{
-\item{data}{Hourly Collaboration query containing signal variables (e.g. \code{Emails_sent_00_01})}
+\item{data}{Hourly Collaboration query containing signal variables (e.g.
+\code{Emails_sent_00_01})}
 
 \item{hr}{Numeric value between 0 to 23 to iterate through}
 
 \item{signals}{Character vector for specifying which signal types to combine.
-Defaults to c("Emails_sent", "IMs_sent"). Other valid values include "Unscheduled_calls" and
-"Meetings".}
+Defaults to \code{c("Emails_sent", "IMs_sent")}. Other valid values include
+\code{"Unscheduled_calls"} and \code{"Meetings"}.}
 }
 \description{
-Takes in an Hourly Collaboration Data, and for each hour sums and aggregates the
-signals (e.g.\code{Emails_sent} and \code{IMs_sent}) in \code{Signals_sent}. This is an internal
-function used in the Working Patterns functions.
+Takes in an Hourly Collaboration Data, and for each hour sums and aggregates
+the signals (e.g.\code{Emails_sent} and \code{IMs_sent}) in \code{Signals_sent}. This is an
+internal function used in the Working Patterns functions.
 }
 \details{
 \code{combine_signals} uses string matching to aggregate columns.
@@ -32,3 +33,11 @@ sim_data <-
 combine_signals(sim_data, hr = 9, signals = c("Emails_sent", "Unscheduled_calls"))
 
 }
+\seealso{
+Other Support: 
+\code{\link{camel_clean}()},
+\code{\link{cut_hour}()},
+\code{\link{extract_date_range}()},
+\code{\link{rgb2hex}()}
+}
+\concept{Support}

man/copy_df.Rd

@@ -7,11 +7,14 @@
 copy_df(x, row.names = FALSE, col.names = TRUE, quietly = FALSE, ...)
 }
 \arguments{
-\item{x}{Data frame to be passed through. Cannot contain list-columns or nested data frames.}
+\item{x}{Data frame to be passed through. Cannot contain list-columns or
+nested data frames.}
 
-\item{row.names}{A logical vector for specifying whether to allow row names. Defaults to FALSE.}
+\item{row.names}{A logical vector for specifying whether to allow row names.
+Defaults to \code{FALSE}.}
 
-\item{col.names}{A logical vector for specifying whether to allow column names. Defaults to FALSE.}
+\item{col.names}{A logical vector for specifying whether to allow column
+names. Defaults to \code{FALSE}.}
 
 \item{quietly}{Set this to TRUE to not print data frame on console}
 
@@ -21,5 +24,12 @@ copy_df(x, row.names = FALSE, col.names = TRUE, quietly = FALSE, ...)
 This is a pipe-optimised function, that feeds into \code{wpa::export()},
 but can be used as a stand-alone function.
 
-Based on the original function at https://www.github.com/martinctc/surveytoolbox.
+Based on the original function from
+https://www.github.com/martinctc/surveytoolbox.
 }
+\seealso{
+Other Import and Export: 
+\code{\link{create_dt}()},
+\code{\link{export}()}
+}
+\concept{Import and Export}

man/create_IV.Rd

@@ -82,3 +82,4 @@ Other Information Value:
 \code{\link{IV_report}()}
 }
 \concept{Information Value}
+\concept{Variable Association}

man/create_bar.Rd

@@ -56,21 +56,69 @@ Additional options available to return a summary table.
 \examples{
 # Return a ggplot bar chart
 create_bar(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation")
-create_bar(sq_data, metric = "Generated_workload_email_hours")
-create_bar(sq_data, metric = "After_hours_collaboration_hours")
+
+# Change bar colour
+create_bar(sq_data,
+           metric = "After_hours_collaboration_hours",
+           bar_colour = "alert")
 
 # Return a summary table
-create_bar(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation", return = "table")
+create_bar(sq_data,
+           metric = "Collaboration_hours",
+           hrvar = "LevelDesignation",
+           return = "table")
 }
 \seealso{
-Other General: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
 \code{\link{create_boxplot}()},
 \code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
 \code{\link{create_scatter}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_hr}()},
-\code{\link{hrvar_count}()},
-\code{\link{identify_outlier}()}
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_hist}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()}
 }
-\concept{General}
+\concept{Flexible}
+\concept{Visualization}

man/create_bar_asis.Rd

@@ -37,7 +37,7 @@ the bars.}
 \item{xlab}{X-axis label of the plot (bar axis).}
 
 \item{percent}{Logical value to determine whether to show labels as
-percentage signs. Defaults to FALSE.}
+percentage signs. Defaults to \code{FALSE}.}
 
 \item{bar_colour}{String to specify colour to use for bars.
 In-built accepted values include "default" (default), "alert" (red), and
@@ -72,16 +72,77 @@ sq_data \%>\%
                   bar_colour = "darkblue",
                   rounding = 0)
 
+library(dplyr)
+
+# Summarise Non-person-average median `Emails_sent`
+med_df <-
+  sq_data \%>\%
+  group_by(Organization) \%>\%
+  summarise(Emails_sent_median = median(Emails_sent))
+
+med_df \%>\%
+  create_bar_asis(
+    group_var = "Organization",
+    bar_var = "Emails_sent_median",
+    title = "Median Emails Sent by Organization",
+    subtitle = "Person Averaging Not Applied",
+    bar_colour = "darkblue",
+    caption = extract_date_range(sq_data, return = "text")
+  )
+
+
 }
 \seealso{
-Other General: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar}()},
 \code{\link{create_boxplot}()},
 \code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
 \code{\link{create_scatter}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_hr}()},
-\code{\link{hrvar_count}()},
-\code{\link{identify_outlier}()}
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other Flexible: 
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_hist}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()}
 }
-\concept{General}
+\concept{Flexible}
+\concept{Visualization}

man/create_boxplot.Rd

@@ -18,11 +18,15 @@ create_boxplot(
 \item{metric}{Character string containing the name of the metric,
 e.g. "Collaboration_hours"}
 
-\item{hrvar}{HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"}
+\item{hrvar}{HR Variable by which to split metrics. Accepts a character
+vector, 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{mingroup}{Numeric value setting the privacy threshold / minimum group
+size, defaults to 5.}
 
-\item{return}{String specifying what to return. This must be one of the following strings:
+\item{return}{String specifying what to return. This must be one of the
+following strings:
 \itemize{
 \item \code{"plot"}
 \item \code{"table"}
@@ -38,7 +42,7 @@ A different output is returned depending on the value passed to the \code{return
 }
 }
 \description{
-Analyzes a selected metric and returns a a 'fizzy' scatter plot by default.
+Analyzes a selected metric and returns a box plot by default.
 Additional options available to return a table with distribution elements.
 }
 \details{
@@ -65,14 +69,56 @@ create_boxplot(sq_data,
                return = "plot")
 }
 \seealso{
-Other General: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
 \code{\link{create_bar}()},
 \code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
 \code{\link{create_scatter}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_hr}()},
-\code{\link{hrvar_count}()},
-\code{\link{identify_outlier}()}
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_hist}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()}
 }
-\concept{General}
+\concept{Flexible}
+\concept{Visualization}

man/create_bubble.Rd

@@ -66,14 +66,56 @@ create_bubble(sq_data,
 
 }
 \seealso{
-Other General: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
 \code{\link{create_bar}()},
 \code{\link{create_boxplot}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
 \code{\link{create_scatter}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_hr}()},
-\code{\link{hrvar_count}()},
-\code{\link{identify_outlier}()}
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_hist}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()}
 }
-\concept{General}
+\concept{Flexible}
+\concept{Visualization}

man/create_dist.Rd

@@ -36,7 +36,8 @@ size, defaults to 5.}
 
 See \code{Value} for more information.}
 
-\item{cut}{A numeric vector of length three to specify the breaks for the distribution,
+\item{cut}{A numeric vector of length three to specify the breaks for the
+distribution,
 e.g. c(10, 15, 20)}
 
 \item{dist_colours}{A character vector of length four to specify colour
@@ -65,14 +66,56 @@ create_dist(sq_data, metric = "Collaboration_hours", hrvar = "Organization")
 create_dist(sq_data, metric = "Collaboration_hours", hrvar = "Organization", return = "table")
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_fizz}()},
 \code{\link{create_hist}()},
 \code{\link{create_line_asis}()},
 \code{\link{create_line}()},
 \code{\link{create_period_scatter}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()},
 \code{\link{create_trend}()}
 }
 \concept{Flexible}
+\concept{Visualization}

man/create_dt.Rd

@@ -17,3 +17,9 @@ which includes the row number column.}
 \description{
 See https://martinctc.github.io/blog/vignette-downloadable-tables-in-rmarkdown-with-the-dt-package/ for more.
 }
+\seealso{
+Other Import and Export: 
+\code{\link{copy_df}()},
+\code{\link{export}()}
+}
+\concept{Import and Export}

man/create_fizz.Rd

@@ -56,14 +56,56 @@ create_fizz(sq_data, metric = "Workweek_span", hrvar = "Organization", return =
 create_fizz(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation", return = "plot")
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_hist}()},
 \code{\link{create_line_asis}()},
 \code{\link{create_line}()},
 \code{\link{create_period_scatter}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()},
 \code{\link{create_trend}()}
 }
 \concept{Flexible}
+\concept{Visualization}

man/create_hist.Rd

@@ -71,12 +71,18 @@ create_hist(sq_data,
 }
 \seealso{
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_fizz}()},
 \code{\link{create_line_asis}()},
 \code{\link{create_line}()},
 \code{\link{create_period_scatter}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()},
 \code{\link{create_trend}()}
 }

man/create_line.Rd

@@ -60,14 +60,62 @@ sq_data \%>\% create_line(metric = "Workweek_span", hrvar = "LevelDesignation")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_fizz}()},
 \code{\link{create_hist}()},
 \code{\link{create_line_asis}()},
 \code{\link{create_period_scatter}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()},
 \code{\link{create_trend}()}
+
+Other Time-series: 
+\code{\link{create_line_asis}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_trend}()}
 }
 \concept{Flexible}
+\concept{Time-series}
+\concept{Visualization}

man/create_line_asis.Rd

@@ -42,16 +42,84 @@ This function creates a line chart directly from the aggregated / summarised dat
 Unlike \code{create_line()} which performs a person-level aggregation, there is no
 calculation for \code{create_line_asis()} and the values are rendered as they are passed
 into the function. The only requirement is that a \code{date_var} is provided for the x-axis.
+}
+\examples{
+library(dplyr)
+
+# Median `Emails_sent` grouped by `Date`
+# Without Person Averaging
+med_df <-
+  sq_data \%>\%
+  group_by(Date) \%>\%
+  summarise(Emails_sent_median = median(Emails_sent))
+
+med_df \%>\%
+  create_line_asis(
+    date_var = "Date",
+    metric = "Emails_sent_median",
+    title = "Median Emails Sent",
+    subtitle = "Person Averaging Not Applied",
+    caption = extract_date_range(sq_data, return = "text")
+  )
+
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_fizz}()},
 \code{\link{create_hist}()},
 \code{\link{create_line}()},
 \code{\link{create_period_scatter}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()},
 \code{\link{create_trend}()}
+
+Other Time-series: 
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_trend}()}
 }
 \concept{Flexible}
+\concept{Time-series}
+\concept{Visualization}

man/create_period_scatter.Rd

@@ -74,14 +74,62 @@ create_period_scatter(sq_data, before_end = "2019-12-31", return = "table")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_fizz}()},
 \code{\link{create_hist}()},
 \code{\link{create_line_asis}()},
 \code{\link{create_line}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()},
 \code{\link{create_trend}()}
+
+Other Time-series: 
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_trend}()}
 }
 \concept{Flexible}
+\concept{Time-series}
+\concept{Visualization}

man/create_rank.Rd

@@ -25,33 +25,115 @@ 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.}
+\item{return}{String specifying what to return. This must be one of the
+following strings:
+\itemize{
+\item \code{"table"} (default)
+\item \code{"plot"}
+}
 
-\item{plot_mode}{Numeric vector to determine which plot mode to return:
-\enumerate{
-\item Top and bottom five groups across the data population are highlighted
-\item Top and bottom groups \emph{per} organizational attribute are highlighted
+See \code{Value} for more information.}
+
+\item{plot_mode}{Numeric vector to determine which plot mode to return. Must
+be either \code{1} or \code{2}, and is only used when \code{return = "plot"}.
+\itemize{
+\item \code{1}: Top and bottom five groups across the data population are highlighted
+\item \code{2}: Top and bottom groups \emph{per} organizational attribute are highlighted
 }}
 }
 \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.
+A different output is returned depending on the value passed to the \code{return}
+argument:
+\itemize{
+\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the
+metric, the y-axis represents the HR attributes, and the size of the
+bubbles represent the size of the organizations.
+\item \code{"table"}: data frame. A summary table for the metric.
+}
 }
 \description{
-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.
+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.
+}
+\examples{
+create_rank(
+  data = sq_data,
+  hrvar = c("FunctionType", "LevelDesignation"),
+  metric = "Emails_sent",
+  return = "plot",
+  plot_mode = 1
+)
+
+# Plot mode 2 - show top and bottom groups per HR variable
+create_rank(
+  data = sq_data,
+  hrvar = c("FunctionType", "LevelDesignation"),
+  metric = "Emails_sent",
+  return = "plot",
+  plot_mode = 2
+)
+
+# Return a table
+create_rank(
+  data = sq_data,
+  metric = "Emails_sent",
+  return = "table"
+)
+
+
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_fizz}()},
 \code{\link{create_hist}()},
 \code{\link{create_line_asis}()},
 \code{\link{create_line}()},
 \code{\link{create_period_scatter}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()},
 \code{\link{create_trend}()}
 }
 \concept{Flexible}
+\concept{Visualization}

man/create_sankey.Rd

@@ -9,14 +9,21 @@ create_sankey(data, var1, var2, count = "n")
 \arguments{
 \item{data}{Data frame of the long count table.}
 
-\item{var1}{String containing the name of the variable to be shown on the left.}
+\item{var1}{String containing the name of the variable to be shown on the
+left.}
 
-\item{var2}{String containing the name of the variable to be shown on the right.}
+\item{var2}{String containing the name of the variable to be shown on the
+right.}
 
 \item{count}{String containing the name of the count variable.}
 }
+\value{
+A 'sankeyNetwork' and 'htmlwidget' object containing a two-tier
+sankey plot. The output can be saved locally with
+\code{htmlwidgets::saveWidget()}.
+}
 \description{
-Create a networkD3 style sankey chart based on a long count table
+Create a 'networkD3' style sankey chart based on a long count table
 with two variables. The input data should have three columns, where
 each row is a unique group:
 \enumerate{
@@ -33,3 +40,57 @@ sq_data \%>\%
 }
 
 }
+\seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_hist}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()}
+}
+\concept{Flexible}
+\concept{Visualization}

man/create_scatter.Rd

@@ -57,14 +57,56 @@ create_scatter(sq_data,
 
 }
 \seealso{
-Other General: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
 \code{\link{create_bar}()},
 \code{\link{create_boxplot}()},
 \code{\link{create_bubble}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_hr}()},
-\code{\link{hrvar_count}()},
-\code{\link{identify_outlier}()}
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
+Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_hist}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()}
 }
-\concept{General}
+\concept{Flexible}
+\concept{Visualization}

man/create_stacked.Rd

@@ -42,8 +42,8 @@ When 'table' is passed, a summary table is returned as a data frame.
 }
 \description{
 Creates a sum total calculation using selected metrics,
-where the typical use case is to create different definitions
-of collaboration hours.
+where the typical use case is to create different definitions of
+collaboration hours.
 Returns a stacked bar plot by default.
 Additional options available to return a summary table.
 }
@@ -70,7 +70,46 @@ sq_data \%>\%
                  return = "table")
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_fizz}()},
 \code{\link{create_hist}()},
@@ -78,6 +117,9 @@ Other Flexible:
 \code{\link{create_line}()},
 \code{\link{create_period_scatter}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_trend}()}
 }
 \concept{Flexible}
+\concept{Visualization}

man/create_trend.Rd

@@ -31,16 +31,56 @@ 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 a selected Workplace Analytics metric.
-By default returns a week by week heatmap bar plot, highlighting the points in time with most activity.
-Additional options available to return a summary table.
+Provides a week by week view of a selected Workplace Analytics metric. By
+default returns a week by week heatmap bar plot, highlighting the points in
+time with most activity. Additional options available to return a summary
+table.
 }
 \examples{
 create_trend(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Flexible: 
+\code{\link{create_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
 \code{\link{create_dist}()},
 \code{\link{create_fizz}()},
 \code{\link{create_hist}()},
@@ -48,6 +88,15 @@ Other Flexible:
 \code{\link{create_line}()},
 \code{\link{create_period_scatter}()},
 \code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
 \code{\link{create_stacked}()}
+
+Other Time-series: 
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()}
 }
 \concept{Flexible}
+\concept{Time-series}
+\concept{Visualization}

man/cut_hour.Rd

@@ -18,6 +18,9 @@ cut points required.}
 Supply a numeric variable, e.g. \code{Collaboration_hours},
 and the function returns a character vector
 }
+\details{
+This is used within \code{create_dist()} for numeric to categorical conversion.
+}
 \examples{
 # Direct use
 cut_hour(1:30, cuts = c(15, 20, 25))
@@ -27,14 +30,10 @@ cut_hour(sq_data$Collaboration_hours, cuts = c(10, 15, 20))
 
 }
 \seealso{
-Other General: 
-\code{\link{create_bar_asis}()},
-\code{\link{create_bar}()},
-\code{\link{create_boxplot}()},
-\code{\link{create_bubble}()},
-\code{\link{create_scatter}()},
-\code{\link{extract_hr}()},
-\code{\link{hrvar_count}()},
-\code{\link{identify_outlier}()}
+Other Support: 
+\code{\link{camel_clean}()},
+\code{\link{combine_signals}()},
+\code{\link{extract_date_range}()},
+\code{\link{rgb2hex}()}
 }
-\concept{General}
+\concept{Support}

man/dv_data.Rd

@@ -87,6 +87,11 @@ A data frame with 897 rows and 69 variables:
 dv_data
 }
 \description{
-A dataset generated from a Standard Person Query from WpA.
+A dataset generated from a Standard Person Query from Workplace Analytics.
 }
+\seealso{
+Other Data: 
+\code{\link{em_data}}
+}
+\concept{Data}
 \keyword{datasets}

man/em_data.Rd

@@ -74,8 +74,13 @@ A data frame with 41567 rows and 56 variables:
 em_data
 }
 \description{
-A sample dataset generated from an Hourly Collaboration query
-from the WpA demo tenant. The data is grouped by week and contains
+A sample dataset generated from an Hourly Collaboration query from the
+Workplace Analytics demo tenant. The data is grouped by week and contains
 columns for both IMs sent and Emails sent.
 }
+\seealso{
+Other Data: 
+\code{\link{dv_data}}
+}
+\concept{Data}
 \keyword{datasets}

man/email_dist.Rd

@@ -30,7 +30,8 @@ size, defaults to 5.}
 
 See \code{Value} for more information.}
 
-\item{cut}{A numeric vector of length three to specify the breaks for the distribution,
+\item{cut}{A numeric vector of length three to specify the breaks for the
+distribution,
 e.g. c(10, 15, 20)}
 }
 \value{
@@ -57,6 +58,41 @@ email_dist(sq_data, hrvar = "LevelDesignation", cut = c(4, 7, 9))
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Emails: 
 \code{\link{email_fizz}()},
 \code{\link{email_line}()},
@@ -65,3 +101,4 @@ Other Emails:
 \code{\link{email_trend}()}
 }
 \concept{Emails}
+\concept{Visualization}

man/email_fizz.Rd

@@ -43,6 +43,41 @@ email_fizz(sq_data, hrvar = "Organization", return = "table")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Emails: 
 \code{\link{email_dist}()},
 \code{\link{email_line}()},
@@ -51,3 +86,4 @@ Other Emails:
 \code{\link{email_trend}()}
 }
 \concept{Emails}
+\concept{Visualization}

man/email_line.Rd

@@ -44,6 +44,41 @@ email_line(sq_data, hrvar = "LevelDesignation", return = "table")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Emails: 
 \code{\link{email_dist}()},
 \code{\link{email_fizz}()},
@@ -52,3 +87,4 @@ Other Emails:
 \code{\link{email_trend}()}
 }
 \concept{Emails}
+\concept{Visualization}

man/email_rank.Rd

@@ -15,22 +15,70 @@ 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.}
+\item{return}{String specifying what to return. This must be one of the
+following strings:
+\itemize{
+\item \code{"table"} (default)
+\item \code{"plot"}
+}
+
+See \code{Value} for more information.}
 }
 \value{
-When 'table' is passed in \code{return}, a summary table is returned as a data frame.
+A different output is returned depending on the value passed to the \code{return}
+argument:
+\itemize{
+\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the
+metric, the y-axis represents the HR attributes, and the size of the
+bubbles represent the size of the organizations.
+\item \code{"table"}: data frame. A summary table for the metric.
+}
 }
 \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.
+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 Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Emails: 
 \code{\link{email_dist}()},
 \code{\link{email_fizz}()},
@@ -39,3 +87,4 @@ Other Emails:
 \code{\link{email_trend}()}
 }
 \concept{Emails}
+\concept{Visualization}

man/email_summary.Rd

@@ -46,6 +46,41 @@ email_summary(sq_data, hrvar = "LevelDesignation", return = "table")
 
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_trend}()},
+\code{\link{hrvar_count}()}
+
 Other Emails: 
 \code{\link{email_dist}()},
 \code{\link{email_fizz}()},
@@ -54,3 +89,4 @@ Other Emails:
 \code{\link{email_trend}()}
 }
 \concept{Emails}
+\concept{Visualization}

man/email_trend.Rd

@@ -30,6 +30,41 @@ Additional options available to return a summary table.
 Uses the metric \code{Email_hours}.
 }
 \seealso{
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
+\code{\link{create_bar}()},
+\code{\link{create_boxplot}()},
+\code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
+\code{\link{create_scatter}()},
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{hrvar_count}()}
+
 Other Emails: 
 \code{\link{email_dist}()},
 \code{\link{email_fizz}()},
@@ -38,3 +73,4 @@ Other Emails:
 \code{\link{email_summary}()}
 }
 \concept{Emails}
+\concept{Visualization}

man/export.Rd

@@ -17,20 +17,47 @@ export(
 \item{x}{Data frame or ggplot object to be passed through.}
 
 \item{method}{Character string specifying the method of export.
-Valid inputs include "clipboard" (default), "csv", "png", "svg", "jpeg", and "pdf".}
+Valid inputs include:
+\itemize{
+\item \code{"clipboard"} (default if input is data frame)
+\item \code{"csv"}
+\item \code{"png"} (default if input is ggplot object)
+\item \code{"svg"}
+\item \code{"jpeg"}
+\item \code{"pdf"}
+}}
 
-\item{path}{If exporting a file, enter the path and the desired file name, \emph{excluding the file extension}.
-For example, "Analysis/SQ Overview".}
+\item{path}{If exporting a file, enter the path and the desired file name,
+\emph{excluding the file extension}. For example, "Analysis/SQ Overview".}
 
-\item{timestamp}{Logical vector specifying whether to include a timestamp in the file name. Defaults to TRUE.}
+\item{timestamp}{Logical vector specifying whether to include a timestamp in
+the file name. Defaults to \code{TRUE}.}
 
 \item{width}{Width of the plot}
 
 \item{height}{Height of the plot}
 }
+\value{
+A different output is returned depending on the value passed to the \code{method}
+argument:
+\itemize{
+\item \code{"clipboard"}: no return - data frame is saved to clipboard.
+\item \code{"csv"}: CSV file containing data frame is saved to specified path.
+\item \code{"png"}: PNG file containing ggplot object is saved to specified path.
+\item \code{"svg"}: SVG file containing ggplot object is saved to specified path.
+\item \code{"jpeg"}: JPEG file containing ggplot object is saved to specified path.
+\item \code{"pdf"}: PDF file containing ggplot object is saved to specified path.
+}
+}
 \description{
 A general use function to export {wpa} outputs to CSV,
 clipboard, or save as images. By default, \code{export()} copies
 a data frame to the clipboard. If the input is a ggplot object,
 the default behaviour is to export a PNG.
 }
+\seealso{
+Other Import and Export: 
+\code{\link{copy_df}()},
+\code{\link{create_dt}()}
+}
+\concept{Import and Export}

man/extract_date_range.Rd

@@ -20,3 +20,11 @@ Return a data frame with the start and end date
 of the query data by default. There are options to return a descriptive
 string, which is used in the caption of plots in this package.
 }
+\seealso{
+Other Support: 
+\code{\link{camel_clean}()},
+\code{\link{combine_signals}()},
+\code{\link{cut_hour}()},
+\code{\link{rgb2hex}()}
+}
+\concept{Support}

man/extract_hr.Rd

@@ -47,13 +47,6 @@ sq_data \%>\% extract_hr(return = "vars")
 }
 \seealso{
 Other General: 
-\code{\link{create_bar_asis}()},
-\code{\link{create_bar}()},
-\code{\link{create_boxplot}()},
-\code{\link{create_bubble}()},
-\code{\link{create_scatter}()},
-\code{\link{cut_hour}()},
-\code{\link{hrvar_count}()},
 \code{\link{identify_outlier}()}
 }
 \concept{General}

man/hrvar_count.Rd

@@ -48,15 +48,40 @@ hrvar_count(sq_data, hrvar = "LevelDesignation", return = "table")
 
 }
 \seealso{
-Other General: 
+Other Visualization: 
+\code{\link{afterhours_dist}()},
+\code{\link{afterhours_fizz}()},
+\code{\link{afterhours_line}()},
+\code{\link{afterhours_rank}()},
+\code{\link{afterhours_summary}()},
+\code{\link{afterhours_trend}()},
+\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_bar_asis}()},
 \code{\link{create_bar}()},
 \code{\link{create_boxplot}()},
 \code{\link{create_bubble}()},
+\code{\link{create_dist}()},
+\code{\link{create_fizz}()},
+\code{\link{create_line_asis}()},
+\code{\link{create_line}()},
+\code{\link{create_period_scatter}()},
+\code{\link{create_rank}()},
+\code{\link{create_sankey}()},
 \code{\link{create_scatter}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_hr}()},
-\code{\link{identify_outlier}()}
+\code{\link{create_stacked}()},
+\code{\link{create_trend}()},
+\code{\link{email_dist}()},
+\code{\link{email_fizz}()},
+\code{\link{email_line}()},
+\code{\link{email_rank}()},
+\code{\link{email_summary}()},
+\code{\link{email_trend}()}
 
 Other Data Validation: 
 \code{\link{check_query}()},
@@ -79,4 +104,4 @@ Other Data Validation:
 \code{\link{track_HR_change}()}
 }
 \concept{Data Validation}
-\concept{General}
+\concept{Visualization}

man/identify_outlier.Rd

@@ -33,14 +33,7 @@ identify_outlier(sq_data, metric = "Collaboration_hours")
 }
 \seealso{
 Other General: 
-\code{\link{create_bar_asis}()},
-\code{\link{create_bar}()},
-\code{\link{create_boxplot}()},
-\code{\link{create_bubble}()},
-\code{\link{create_scatter}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_hr}()},
-\code{\link{hrvar_count}()}
+\code{\link{extract_hr}()}
 
 Other Data Validation: 
 \code{\link{check_query}()},

man/meeting_dist.Rd

@@ -30,7 +30,8 @@ size, defaults to 5.}
 
 See \code{Value} for more information.}
 
-\item{cut}{A numeric vector of length three to specify the breaks for the distribution,
+\item{cut}{A numeric vector of length three to specify the breaks for the
+distribution,
 e.g. c(10, 15, 20)}
 }
 \value{

man/meeting_rank.Rd

@@ -15,9 +15,14 @@ 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.}
+\item{return}{String specifying what to return. This must be one of the
+following strings:
+\itemize{
+\item \code{"table"} (default)
+\item \code{"plot"}
+}
+
+See \code{Value} for more information.}
 }
 \value{
 When 'table' is passed in \code{return}, a summary table is returned as a data frame.

man/one2one_dist.Rd

@@ -30,7 +30,8 @@ size, defaults to 5.}
 
 See \code{Value} for more information.}
 
-\item{cut}{A numeric vector of length three to specify the breaks for the distribution,
+\item{cut}{A numeric vector of length three to specify the breaks for the
+distribution,
 e.g. c(10, 15, 20)}
 }
 \value{

man/one2one_rank.Rd

@@ -15,9 +15,14 @@ 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.}
+\item{return}{String specifying what to return. This must be one of the
+following strings:
+\itemize{
+\item \code{"table"} (default)
+\item \code{"plot"}
+}
+
+See \code{Value} for more information.}
 }
 \value{
 When 'table' is passed in \code{return}, a summary table is returned as a data frame.

man/rgb2hex.Rd

@@ -12,3 +12,11 @@ rgb2hex(r, g, b)
 \description{
 Convert rgb to HEX code
 }
+\seealso{
+Other Support: 
+\code{\link{camel_clean}()},
+\code{\link{combine_signals}()},
+\code{\link{cut_hour}()},
+\code{\link{extract_date_range}()}
+}
+\concept{Support}

man/workloads_dist.Rd

@@ -30,7 +30,8 @@ size, defaults to 5.}
 
 See \code{Value} for more information.}
 
-\item{cut}{A numeric vector of length three to specify the breaks for the distribution,
+\item{cut}{A numeric vector of length three to specify the breaks for the
+distribution,
 e.g. c(10, 15, 20)}
 }
 \value{

man/workloads_rank.Rd

@@ -15,9 +15,14 @@ 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.}
+\item{return}{String specifying what to return. This must be one of the
+following strings:
+\itemize{
+\item \code{"table"} (default)
+\item \code{"plot"}
+}
+
+See \code{Value} for more information.}
 }
 \value{
 When 'table' is passed in \code{return}, a summary table is returned as a data frame.