docs: make branding replacements

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_.

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.
 #'

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

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.

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 <carlos.morales@@microsoft.com>

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) +

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.

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: 

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.
 }

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

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,

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{

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,

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.