docs: spellchecks

R/IV_by_Period.R

@@ -16,7 +16,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
-#'   WpA query output.
+#'   Workplace Analytics query output.
 #' @param before_start Start date of "before" time period in `YYYY-MM-DD`.
 #'   Defaults to earliest date in dataset.
 #' @param before_end End date of "before" time period in `YYYY-MM-DD`

R/flag_ch_ratio.R

@@ -25,7 +25,7 @@
 #' @return
 #' A different output is returned depending on the value passed to the `return`
 #' argument:
-#'   - `"message"`: message in the console containing diagnotic summary
+#'   - `"message"`: message in the console containing diagnostic summary
 #'   - `"text"`: string containing diagnotic summary
 #'   - `"data"`: data frame. Person-level data with flags on unusually high or
 #'   low ratios

R/meetingtype_dist_ca.R

@@ -1,8 +1,8 @@
 #' @title Meeting Type Distribution (Ways of Working Assessment Query)
 #'
 #' @description
-#' Calculate the hour distribution of internal meeting types,
-#' using a Ways of Working Assessment Query with core WpA variables as an input.
+#' Calculate the hour distribution of internal meeting types, using a Ways of
+#' Working Assessment Query with core Workplace Analytics variables as an input.
 #'
 #' @param data Meeting Query data frame. Must contain the variables `Attendee` and `DurationHours`
 #' @param hrvar Character string to specify the HR attribute to split the data by.

R/meetingtype_dist_mt.R

@@ -1,8 +1,8 @@
 #' @title Meeting Type Distribution (Meeting Query)
 #'
 #' @description
-#' Calculate the hour distribution of internal meeting types,
-#' using a Meeting Query with core WpA variables as an input.
+#' Calculate the hour distribution of internal meeting types, using a Meeting
+#' Query with core Workplace Analytics variables as an input.
 #'
 #' @param data Meeting Query data frame. Must contain the variables `Attendee` and `DurationHours`
 #' @param return String specifying what to return. This must be one of the

R/tm_cooc.R

@@ -7,7 +7,7 @@
 #' Analyse word co-occurrence in subject lines and return a network plot
 #'
 #' @description
-#' This function generates a word co-occurence network plot, with options to
+#' This function generates a word co-occurrence network plot, with options to
 #' return a table. This function is used within `meeting_tm_report()`.
 #'
 #' @author Carlos Morales <carlos.morales@@microsoft.com>

R/track_hr_change.R

@@ -9,7 +9,7 @@
 #' @description
 #' Creates a list of everyone at a specified start date and a specified end date
 #' then aggregates up people who have moved between orgs between this to points
-#' of time and visualiazes the move through a sankey chart.
+#' of time and visualizes the move through a sankey chart.
 #' Through this chart you can see:
 #' -  The HR attribute/orgs that have the highest move out
 #' -  The HR attribute/orgs that have the highest move in

man/IV_by_period.Rd

@@ -18,7 +18,7 @@ IV_by_period(
 \arguments{
 \item{data}{Person Query as a dataframe including date column named "Date"
 This function assumes the data format is \code{MM/DD/YYYY} as is standard in a
-WpA query output.}
+Workplace Analytics query output.}
 
 \item{before_start}{Start date of "before" time period in \code{YYYY-MM-DD}.
 Defaults to earliest date in dataset.}

man/flag_ch_ratio.Rd

@@ -24,7 +24,7 @@ Defaults to 30.}
 A different output is returned depending on the value passed to the \code{return}
 argument:
 \itemize{
-\item \code{"message"}: message in the console containing diagnotic summary
+\item \code{"message"}: message in the console containing diagnostic summary
 \item \code{"text"}: string containing diagnotic summary
 \item \code{"data"}: data frame. Person-level data with flags on unusually high or
 low ratios

man/hrvar_count_all.Rd

@@ -38,6 +38,8 @@ beyond the specified thresholds.
 }
 }
 \description{
+\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
+
 This function enables you to create a summary table to validate
 organizational data. This table will provide a summary of the data found in
 the Workplace Analytics Sources page. This function will return a summary

man/meetingtype_dist_ca.Rd

@@ -34,8 +34,8 @@ is passed to \code{hrvar}, a stacked bar plot is returned.
 }
 }
 \description{
-Calculate the hour distribution of internal meeting types,
-using a Ways of Working Assessment Query with core WpA variables as an input.
+Calculate the hour distribution of internal meeting types, using a Ways of
+Working Assessment Query with core Workplace Analytics variables as an input.
 }
 \seealso{
 Other Visualization: 

man/meetingtype_dist_mt.Rd

@@ -30,8 +30,8 @@ is passed to \code{hrvar}, a stacked bar plot is returned.
 }
 }
 \description{
-Calculate the hour distribution of internal meeting types,
-using a Meeting Query with core WpA variables as an input.
+Calculate the hour distribution of internal meeting types, using a Meeting
+Query with core Workplace Analytics variables as an input.
 }
 \seealso{
 Other Visualization: 

man/one2one_freq.Rd

@@ -48,11 +48,29 @@ A different output is returned depending on the value passed to the \code{return
 }
 }
 \description{
+\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
+
 This function calculates the average number of weeks (cadence) between of 1:1
 meetings between an employee and their manager. Returns a  distribution plot
 for typical cadence of 1:1 meetings. Additional options available to return a
 bar plot, tables, or a data frame with a cadence of 1 on 1 meetings metric.
 }
+\section{Distribution view}{
+
+For this view, there are four categories of cadence:
+\itemize{
+\item Weekly (once per week)
+\item Twice monthly or more (up to 3 weeks)
+\item Monthly (3 - 6 weeks)
+\item Every two months (6 - 10 weeks)
+\item Quarterly or less (> 10 weeks)
+}
+
+In the occasion there are zero 1:1 meetings with managers, this is included
+into the last category, i.e. 'Quarterly or less'. Note that when \code{mode} is
+set to \code{"sum"}, these rows are simply excluded from the calculation.
+}
+
 \examples{
 # Return plot, mode dist
 one2one_freq(sq_data,

man/tm_cooc.Rd

@@ -35,7 +35,7 @@ argument:
 }
 }
 \description{
-This function generates a word co-occurence network plot, with options to
+This function generates a word co-occurrence network plot, with options to
 return a table. This function is used within \code{meeting_tm_report()}.
 }
 \details{

man/track_HR_change.Rd

@@ -42,7 +42,7 @@ When 'table' is passed, a summary table is returned as a data frame.
 \description{
 Creates a list of everyone at a specified start date and a specified end date
 then aggregates up people who have moved between orgs between this to points
-of time and visualiazes the move through a sankey chart.
+of time and visualizes the move through a sankey chart.
 Through this chart you can see:
 \itemize{
 \item The HR attribute/orgs that have the highest move out

vignettes/intro-to-wpa.Rmd

@@ -142,7 +142,7 @@ sq_data %>% mgrrel_matrix(hrvar = "LevelDesignation", return = "chartdata")
 
 ### Distribution of Time spent with Manager
 
-The `mgrcoatt_dist()` function generates the distribution of meeting co-attendence rate of staff with managers.
+The `mgrcoatt_dist()` function generates the distribution of meeting co-attendance rate of staff with managers.
 
 ```{r}
 sq_data %>% mgrcoatt_dist(hrvar = "LevelDesignation")