diff --git a/R/capacity_report.R b/R/capacity_report.R index 822c2ddb..5df82260 100644 --- a/R/capacity_report.R +++ b/R/capacity_report.R @@ -6,11 +6,10 @@ #' @title Generate a Capacity report in HTML #' #' @description -#' The function generates an interactive HTML report using the -#' Standard Person Query data as an input. The report contains a series -#' of summary analysis and visualisations relating to key **capacity** -#' metrics in Workplace Analytics,including length of week and -#' time in after-hours collaboration. +#' The function generates an interactive HTML report using the Standard Person +#' Query data as an input. The report contains a series of summary analysis and +#' visualisations relating to key **capacity** metrics in Viva +#' Insights,including length of week and time in after-hours collaboration. #' #' @template spq-params #' @param path Pass the file path and the desired file name, _excluding the file extension_. diff --git a/R/coaching_report.R b/R/coaching_report.R index e4aada84..d4473363 100644 --- a/R/coaching_report.R +++ b/R/coaching_report.R @@ -8,7 +8,7 @@ #' @description #' The function generates an interactive HTML report using Standard Person Query #' data as an input. The report contains a series of summary analysis and -#' visualisations relating to key **coaching** metrics in Workplace Analytics, +#' visualisations relating to key **coaching** metrics in Viva Insights, #' specifically relating to the time spent between managers and their direct #' reports. #' diff --git a/R/create_ITSA.R b/R/create_ITSA.R index c6b53a5e..3cc6b591 100644 --- a/R/create_ITSA.R +++ b/R/create_ITSA.R @@ -27,7 +27,7 @@ #' #' @param data Person Query as a dataframe including date column named `Date`. #' This function assumes the data format is MM/DD/YYYY as is standard in a -#' Workplace Analytics query output. +#' Viva Insights query output. #' @param before_start Start date of 'before' time period in MM/DD/YYYY format #' as character type. Before time period is the period before the intervention #' (e.g. training program, re-org, shift to remote work) occurs and bounded by diff --git a/R/create_bubble.R b/R/create_bubble.R index cb92a3e1..27d57660 100644 --- a/R/create_bubble.R +++ b/R/create_bubble.R @@ -3,9 +3,8 @@ # Licensed under the MIT License. See LICENSE.txt in the project root for license information. # -------------------------------------------------------------------------------------------- -#' @title Create a bubble plot with two selected Workplace Analytics metrics -#' (General Purpose), with size representing the number of employees in the -#' group. +#' @title Create a bubble plot with two selected Viva Insights metrics (General +#' Purpose), with size representing the number of employees in the group. #' #' @description Returns a bubble plot of two selected metrics, using size to map #' the number of employees. diff --git a/R/create_rank.R b/R/create_rank.R index eb25bbc2..2eb771fe 100644 --- a/R/create_rank.R +++ b/R/create_rank.R @@ -3,11 +3,12 @@ # Licensed under the MIT License. See LICENSE.txt in the project root for license information. # -------------------------------------------------------------------------------------------- -#' @title Rank all groups across HR attributes on a selected Workplace Analytics metric +#' @title +#' Rank all groups across HR attributes on a selected Viva Insights 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 +#' levels of a given Viva Insights Metric. Returns a table with all groups #' (across multiple HR attributes) ranked by the specified metric. #' #' @author Carlos Morales Torrado diff --git a/R/create_scatter.R b/R/create_scatter.R index 97748f7f..6537fa2e 100644 --- a/R/create_scatter.R +++ b/R/create_scatter.R @@ -3,7 +3,8 @@ # Licensed under the MIT License. See LICENSE.txt in the project root for license information. # -------------------------------------------------------------------------------------------- -#' @title Create a Scatter plot with two selected Workplace Analytics metrics (General Purpose) +#' @title +#' Create a Scatter plot with two selected Viva Insights metrics (General Purpose) #' #' @description #' Returns a scatter plot of two selected metrics, using colour to map @@ -94,7 +95,7 @@ create_scatter <- function(data, y = !!sym(metric_y), colour = !!sym(hrvar))) + geom_point(alpha = 0.5) + - labs(title = paste0(clean_x, " and ", clean_y), + labs(title = paste0(clean_x, " and ", clean_y), subtitle = paste("Distribution of employees by", tolower(camel_clean(hrvar))), caption = extract_date_range(data, return = "text")) + xlab(clean_x) + diff --git a/R/create_trend.R b/R/create_trend.R index 233d3d39..10711aeb 100644 --- a/R/create_trend.R +++ b/R/create_trend.R @@ -6,7 +6,7 @@ #' @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 +#' Provides a week by week view of a selected Viva Insights 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. diff --git a/man/capacity_report.Rd b/man/capacity_report.Rd index 7a264d35..73f49fdc 100644 --- a/man/capacity_report.Rd +++ b/man/capacity_report.Rd @@ -34,11 +34,10 @@ generated in the working directory. No outputs are directly returned by the function. } \description{ -The function generates an interactive HTML report using the -Standard Person Query data as an input. The report contains a series -of summary analysis and visualisations relating to key \strong{capacity} -metrics in Workplace Analytics,including length of week and -time in after-hours collaboration. +The function generates an interactive HTML report using the Standard Person +Query data as an input. The report contains a series of summary analysis and +visualisations relating to key \strong{capacity} metrics in Viva +Insights,including length of week and time in after-hours collaboration. } \seealso{ Other Reports: diff --git a/man/coaching_report.Rd b/man/coaching_report.Rd index b031ce89..f74fea03 100644 --- a/man/coaching_report.Rd +++ b/man/coaching_report.Rd @@ -36,7 +36,7 @@ function. \description{ The function generates an interactive HTML report using Standard Person Query data as an input. The report contains a series of summary analysis and -visualisations relating to key \strong{coaching} metrics in Workplace Analytics, +visualisations relating to key \strong{coaching} metrics in Viva Insights, specifically relating to the time spent between managers and their direct reports. } diff --git a/man/create_ITSA.Rd b/man/create_ITSA.Rd index 0217084d..2fdf5b70 100644 --- a/man/create_ITSA.Rd +++ b/man/create_ITSA.Rd @@ -18,7 +18,7 @@ create_ITSA( \arguments{ \item{data}{Person Query as a dataframe including date column named \code{Date}. This function assumes the data format is MM/DD/YYYY as is standard in a -Workplace Analytics query output.} +Viva Insights query output.} \item{before_start}{Start date of 'before' time period in MM/DD/YYYY format as character type. Before time period is the period before the intervention diff --git a/man/create_bubble.Rd b/man/create_bubble.Rd index 8b9677a3..1bf6b4c9 100644 --- a/man/create_bubble.Rd +++ b/man/create_bubble.Rd @@ -2,9 +2,8 @@ % Please edit documentation in R/create_bubble.R \name{create_bubble} \alias{create_bubble} -\title{Create a bubble plot with two selected Workplace Analytics metrics -(General Purpose), with size representing the number of employees in the -group.} +\title{Create a bubble plot with two selected Viva Insights metrics (General +Purpose), with size representing the number of employees in the group.} \usage{ create_bubble( data, diff --git a/man/create_rank.Rd b/man/create_rank.Rd index bfb96a9b..5b02eba2 100644 --- a/man/create_rank.Rd +++ b/man/create_rank.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/create_rank.R \name{create_rank} \alias{create_rank} -\title{Rank all groups across HR attributes on a selected Workplace Analytics metric} +\title{Rank all groups across HR attributes on a selected Viva Insights metric} \usage{ create_rank( data, @@ -62,7 +62,7 @@ plot output if \code{mode} is set to \code{"combine"}. } \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 +levels of a given Viva Insights Metric. Returns a table with all groups (across multiple HR attributes) ranked by the specified metric. } \examples{ diff --git a/man/create_scatter.Rd b/man/create_scatter.Rd index e16a50b0..ab6d4644 100644 --- a/man/create_scatter.Rd +++ b/man/create_scatter.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/create_scatter.R \name{create_scatter} \alias{create_scatter} -\title{Create a Scatter plot with two selected Workplace Analytics metrics (General Purpose)} +\title{Create a Scatter plot with two selected Viva Insights metrics (General Purpose)} \usage{ create_scatter( data, diff --git a/man/create_trend.Rd b/man/create_trend.Rd index 05f0c4ca..c05612b5 100644 --- a/man/create_trend.Rd +++ b/man/create_trend.Rd @@ -38,7 +38,7 @@ 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 +Provides a week by week view of a selected Viva Insights 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.