microsoft
/
wpa
зеркало из https://github.com/microsoft/wpa.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

docs: adjust function family (#58) 

Aligned all function family with this commit.
This commit is contained in:
Martin Chan 2021-03-05 14:05:00 +00:00
Родитель b0b3c2504d
Коммит a9380fc47f
217 изменённых файлов: 4994 добавлений и 689 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

2
R/IV_report.R
Просмотреть файл

@ -21,7 +21,7 @@
#' @param bins Number of bins to use in `Information::create_infotables()`,
#' defaults to 10.
#' @param path Pass the file path and the desired file name, _excluding the file
#' extension_. For example, "collaboration report".
#' extension_. For example, `"IV report"`.
#' @param timestamp Logical vector specifying whether to include a timestamp in
#' the file name. Defaults to TRUE.
#'

7
R/capacity_report.R
Просмотреть файл

@ -12,12 +12,9 @@
#' metrics in Workplace Analytics,including length of week and
#' time in after-hours collaboration.
#'
#' @param data A Standard Person Query dataset in the form of a data frame.
#' @param hrvar HR Variable by which to split metrics, 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.
#' @template spq-params
#' @param path Pass the file path and the desired file name, _excluding the file extension_.
#' For example, "capacity report".
#' For example, `"capacity report"`.
#' @param timestamp Logical vector specifying whether to include a timestamp in the file name.
#' Defaults to TRUE.
#'

23
R/coaching_report.R
Просмотреть файл

@ -6,20 +6,17 @@
#' @title Generate a Coaching report in HTML
#'
#' @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, specifically relating to the time
#' spent between managers and their direct reports.
#' 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,
#' specifically relating to the time spent between managers and their direct
#' reports.
#'
#' @param data A Standard Person Query dataset in the form of a data frame.
#' @param hrvar HR Variable by which to split metrics, defaults to "LevelDesignation"
#' but accepts any character vector, e.g. "LevelDesignation"
#' @param mingroup Numeric value setting the privacy threshold / minimum group size. Defaults to 5.
#' @param path Pass the file path and the desired file name, _excluding the file extension_.
#' For example, "collaboration report".
#' @param timestamp Logical vector specifying whether to include a timestamp in the file name.
#' Defaults to TRUE.
#' @template spq-params
#' @param path Pass the file path and the desired file name, _excluding the file
#' extension_. For example, `"coaching report"`.
#' @param timestamp Logical vector specifying whether to include a timestamp in
#' the file name. Defaults to `TRUE`.
#'
#' @importFrom purrr map_if
#' @importFrom dplyr `%>%`

17
R/collaboration_report.R
Просмотреть файл

@ -6,19 +6,14 @@
#' @title Generate a Collaboration Report in HTML
#'
#' @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 **collaboration**
#' metrics in Workplace Analytics,including email and meeting hours.
#' 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 **collaboration** metrics in Workplace
#' Analytics,including email and meeting hours.
#'
#' @param data A Standard Person Query dataset in the form of a data frame.
#' @param hrvar HR Variable by which to split metrics. Defaults to `"AUTO"`,
#' where the HR variable with most collaboration variance is automatically
#' selected. Also accepts any character vector, e.g. "LevelDesignation"
#' @param mingroup Numeric value setting the privacy threshold / minimum group
#' size. Defaults to 5.
#' @template spq-params
#' @param path Pass the file path and the desired file name, _excluding the file
#' extension_. For example, "collaboration report".
#' extension_. For example, `"collaboration report"`.
#' @param timestamp Logical vector specifying whether to include a timestamp in
#' the file name. Defaults to `TRUE`.
#'

22
R/connectivity_report.R
Просмотреть файл

@ -6,20 +6,16 @@
#' @title Generate a Connectivity report in HTML
#'
#' @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 **connectivity**
#' metrics in Workplace Analytics, including external/internal network size
#' vs breadth.
#' 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 **connectivity** metrics in Workplace
#' Analytics, including external/internal network size vs breadth.
#'
#' @param data A Standard Person Query dataset in the form of a data frame.
#' @param hrvar HR Variable by which to split metrics, 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 path Pass the file path and the desired file name, _excluding the file extension_.
#' For example, "collaboration report".
#' @param timestamp Logical vector specifying whether to include a timestamp in the file name.
#' Defaults to TRUE.
#' @template spq-params
#' @param path Pass the file path and the desired file name, _excluding the file
#' extension_. For example, `"connectivity report"`.
#' @param timestamp Logical vector specifying whether to include a timestamp in
#' the file name. Defaults to `TRUE`.
#'
#' @importFrom purrr map_if
#' @importFrom dplyr `%>%`

2
R/copy_df.R
Просмотреть файл

@ -10,7 +10,7 @@
#' but can be used as a stand-alone function.
#'
#' Based on the original function from
#' https://www.github.com/martinctc/surveytoolbox.
#' <https://www.github.com/martinctc/surveytoolbox>.
#'
#' @param x Data frame to be passed through. Cannot contain list-columns or
#' nested data frames.

4
R/create_IV.R
Просмотреть файл

@ -177,6 +177,10 @@ create_IV <- function(data,
#' ggplot object. Bar plot with 'WOE' as the y-axis and bins of the predictor
#' variable as the horizontal axis.
#'
#' @family Support
#' @family Variable Association
#' @family Information Value
#'
#' @import dplyr
#' @import ggplot2
#'

4
R/create_dt.R
Просмотреть файл

@ -6,7 +6,9 @@
#' @title Create interactive tables in HTML with 'download' buttons.
#'
#' @description
#' See https://martinctc.github.io/blog/vignette-downloadable-tables-in-rmarkdown-with-the-dt-package/ for more.
#' See
#' <https://martinctc.github.io/blog/vignette-downloadable-tables-in-rmarkdown-with-the-dt-package/>
#' for more.
#'
#' @param x Data frame to be passed through.
#' @param rounding Numeric vector to specify the number of decimal points to display

2
R/export.R
Просмотреть файл

@ -21,7 +21,7 @@
#' - `"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".
#' _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

5
R/generate_report.R
Просмотреть файл

@ -185,6 +185,9 @@ generate_chunks <- function(level = 3,
#'
#' @param path Text string containing the path for the appropriate Markdown file.
#'
#' @family Support
#' @family Reports
#'
#' @export
read_preamble <- function(path){
@ -210,6 +213,8 @@ read_preamble <- function(path){
#'
#' @param text Character vector containing Markdown text
#'
#' @family Support
#'
md2html <- function(text){
html_chunk <- markdown::markdownToHTML(text = text,

2
R/keymetrics_scan.R
Просмотреть файл

@ -24,6 +24,8 @@
#' 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.
#'
#' @family Visualization
#'
#' @examples
#' # Heatmap plot is returned by default
#' keymetrics_scan(sq_data)

16
R/maxmin.R
Просмотреть файл

@ -1,16 +1,22 @@
#' @title Max-Min Scaling Function
#'
#' @description This function allows you to scale vectors or an entire data frame using the max-min scaling method
#' A numeric vector is always returned. Originally implemented in https://github.com/martinctc/surveytoolbox.
#' @description This function allows you to scale vectors or an entire data
#' frame using the max-min scaling method A numeric vector is always returned.
#' Originally implemented in <https://github.com/martinctc/surveytoolbox>.
#'
#' @details This is used within `keymetrics_scan()` to enable row-wise heatmapping.
#' @details This is used within `keymetrics_scan()` to enable row-wise
#' heatmapping.
#'
#' @param x Pass a vector or the required columns of a data frame through this argument.
#' @param x Pass a vector or the required columns of a data frame through this
#' argument.
#' @keywords max-min
#' @export
#'
#' @family Support
#'
#' @examples
#' numbers <- c(15, 40, 10, 2)
#' maxmin(numbers)
#'
#' @export
maxmin <- function(x){

3
R/meeting_dist.R
Просмотреть файл

@ -13,7 +13,8 @@
#' @inheritParams create_dist
#' @inherit create_dist return
#'
#' @family Meeting Culture
#' @family Visualization
#' @family Meetings
#'
#' @examples
#' # Return plot

2
R/meeting_extract.R
Просмотреть файл

@ -35,6 +35,8 @@
#' @import dplyr
#' @importFrom data.table ":=" "%like%" "%between%"
#'
#' @family Meetings
#'
#' @examples
#' meeting_extract(mt_data,
#' recurring_only = FALSE,

11
R/meeting_fizz.R
Просмотреть файл

@ -6,18 +6,23 @@
#' @title Distribution of Meeting Hours (Fizzy Drink plot)
#'
#' @description
#' Analyze weekly meeting hours distribution, and returns
#' a 'fizzy' scatter plot by default.
#' Additional options available to return a table with distribution elements.
#' Analyze weekly meeting hours distribution, and returns a 'fizzy' scatter plot
#' by default. Additional options available to return a table with distribution
#' elements.
#'
#' @details
#' Uses the metric `Meeting_hours`.
#'
#' @inheritParams create_fizz
#'
#' @family Visualization
#' @family Meetings
#'
#' @examples
#' # Return plot
#' meeting_fizz(sq_data, hrvar = "Organization", return = "plot")
#'
#' # Return summary table
#' meeting_fizz(sq_data, hrvar = "Organization", return = "table")
#' @export

8
R/meeting_line.R
Просмотреть файл

@ -14,6 +14,7 @@
#' @inheritParams create_line
#' @inherit create_line return
#'
#' @family Visualization
#' @family Meetings
#'
#' @examples
@ -25,9 +26,10 @@
#'
#' @export
meeting_line <- function(data,
hrvar = "Organization",
mingroup = 5,
return = "plot"){
hrvar = "Organization",
mingroup = 5,
return = "plot"){
## Inherit arguments
create_line(data = data,
metric = "Meeting_hours",

8
R/meeting_quality.R
Просмотреть файл

@ -5,10 +5,11 @@
#' @title Run a meeting habits / meeting quality analysis
#'
#' @description Return an analysis of Meeting Quality with a bubble plot, using a Standard Person
#' Query as an input.
#' @description Return an analysis of Meeting Quality with a bubble plot, using
#' a Standard Person Query as an input.
#'
#' @inheritParams create_bubble
#'
#' @param metric_x String specifying which variable to show in the x-axis when
#' returning a plot. Must be one of the following:
#' - `"Low_quality_meeting_hours"` (default)
@ -21,6 +22,9 @@
#'
#' @import dplyr
#'
#' @family Visualization
#' @family Meetings
#'
#' @examples
#' # Return plot
#' meeting_quality(sq_data, return = "plot")

9
R/meeting_rank.R
Просмотреть файл

@ -6,19 +6,20 @@
#' @title Meeting 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 Meeting Collaboration. Returns a table with a all of groups (across
#' multiple HR attributes) ranked by hours of digital collaboration.
#'
#' @details
#' Uses the metric `Meeting_hours`.
#' See `create_rank()` for applying the same analysis to a different metric.
#'
#' @inheritParams create_rank
#' @inherit create_rank return
#'
#' @family Visualization
#' @family Meetings
#'
#' @return
#' When 'table' is passed in `return`, a summary table is returned as a data frame.
#'
#' @export

10
R/meeting_skim.R
Просмотреть файл

@ -26,6 +26,8 @@
#'
#' @import dplyr
#'
#' @family Meetings
#'
#' @examples
#' meeting_skim(sq_data)
#'
@ -105,13 +107,21 @@ meeting_skim <- function(data, return = "message"){
bracket(extract_prop("Multitasking_meeting_hours")))
if(return == "message"){
message(print_text)
} else if(return == "text"){
print_text <- gsub(pattern = ">>>", replacement = " - ", x = print_text)
print_text
} else if(return == "table"){
key_output
} else {
stop("Please check `return`")
}
}

1
R/meeting_summary.R
Просмотреть файл

@ -13,6 +13,7 @@
#' @inheritParams create_bar
#' @inherit create_bar return
#'
#' @family Visualization
#' @family Meetings
#'
#' @examples

11
R/meeting_tm_report.R
Просмотреть файл

@ -4,17 +4,18 @@
#' Create a text mining report in HTML based on Meeting Subject Lines
#'
#' @param data A Meeting Query dataset in the form of a data frame.
#' @param path Pass the file path and the desired file name, _excluding the file extension_.
#' For example, "meeting text mining report".
#' @param stopwords A single-column data frame labelled 'word' containing custom
#' stopwords to remove.
#' @param path Pass the file path and the desired file name, _excluding the file
#' extension_. For example, `"meeting text mining report"`.
#' @param stopwords A single-column data frame labelled `'word'` containing
#' custom stopwords to remove.
#' @param timestamp Logical vector specifying whether to include a timestamp in
#' the file name. Defaults to TRUE.
#' @param keep A numeric vector specifying maximum number of words to keep.
#' @param seed A numeric vector to set seed for random generation.
#'
#' @family Text-mining
#' @family Reports
#' @family Meetings
#' @family Text-mining
#'
#' @inherit generate_report return
#'

12
R/meeting_trend.R
Просмотреть файл

@ -1,21 +1,19 @@
#' @title Meeting Hours Time Trend
#'
#' @description
#' Provides a week by week view of meeting time.
#' By default returns a week by week heatmap, highlighting the points in time with most activity.
#' Additional options available to return a summary table.
#' Provides a week by week view of meeting time. By default returns a week by
#' week heatmap, highlighting the points in time with most activity. Additional
#' options available to return a summary table.
#'
#' @details
#' Uses the metric `Meeting_hours`.
#'
#' @inheritParams create_trend
#' @inherit create_trend return
#'
#' @family Visualization
#' @family Meetings
#'
#' @return
#' Returns a ggplot object by default, where 'plot' is passed in `return`.
#' When 'table' is passed, a summary table is returned as a data frame.
#'
#' @export
meeting_trend <- function(data,

45
R/meetingtype_dist.R
Просмотреть файл

@ -1,24 +1,43 @@
#' @title Distribution of Meeting Types by number of Attendees and Duration
#'
#' @description
#' Calculate the hour distribution of internal meeting types.
#' This is a wrapper around `meetingtype_dist_mt()` and
#' `meetingtype_dist_ca()`, depending on whether a Meeting Query or a Ways of Working Assessment Query
#' is passed as an input.
#' @description Calculate the hour distribution of internal meeting types. This
#' is a wrapper around `meetingtype_dist_mt()` and `meetingtype_dist_ca()`,
#' depending on whether a Meeting Query or a Ways of Working Assessment Query is
#' passed as an input.
#'
#' @param data Data frame. If a meeting query, must contain the variables `Attendee` and `DurationHours`.
#' @param hrvar Character string to specify the HR attribute to split the data by.
#' Note that this is only applicable if a Ways of Working Assessment query is passed to the function. If a Meeting Query
#' is passed instead, this argument is ignored.
#' @param mingroup Numeric value setting the privacy threshold / minimum group size. Defaults to 5.
#' Only applicable when using a Ways of Working Assessment query.
#' @param return Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @param data Data frame. If a meeting query, must contain the variables
#' `Attendee` and `DurationHours`.
#' @param hrvar Character string to specify the HR attribute to split the data
#' by. Note that this is only applicable if a Ways of Working Assessment query
#' is passed to the function. If a Meeting Query is passed instead, this
#' argument is ignored.
#' @param mingroup Numeric value setting the privacy threshold / minimum group
#' size. Defaults to 5. Only applicable when using a Ways of Working
#' Assessment query.
#'
#' @param return String specifying what to return. This must be one of the
#' following strings:
#' - `"plot"`
#' - `"table"`
#'
#' See `Value` for more information.
#'
#' @return
#' A different output is returned depending on the value passed to the `return`
#' argument:
#' - `"plot"`: ggplot object. A matrix of meeting types with duration and the
#' number of attendees. If using a Ways of Working Assessment query with
#' `meetingtype_dist_ca()` and an HR attribute with more than one unique value
#' is passed to `hrvar`, a stacked bar plot is returned.
#' - `"table"`: data frame. A summary table.
#'
#' @import ggplot2
#' @import dplyr
#' @importFrom stats setNames
#'
#' @family Visualization
#' @family Meetings
#'
#' @examples
#' # Implementation using Standard Meeting Query
#' meetingtype_dist(mt_data)

13
R/meetingtype_dist_ca.R
Просмотреть файл

@ -7,13 +7,22 @@
#' @param data Meeting Query data frame. Must contain the variables `Attendee` and `DurationHours`
#' @param hrvar Character string to specify the HR attribute to split the data by.
#' @param mingroup Numeric value setting the privacy threshold / minimum group size. Defaults to 5.
#' @param return Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @param return String specifying what to return. This must be one of the
#' following strings:
#' - `"plot"`
#' - `"table"`
#'
#' See `Value` for more information.
#'
#' @import ggplot2
#' @import dplyr
#' @importFrom stats setNames
#'
#' @inherit meetingtype_dist return
#'
#' @family Visualization
#' @family Meetings
#'
#' @export
meetingtype_dist_ca <- function(data,

13
R/meetingtype_dist_mt.R
Просмотреть файл

@ -5,13 +5,22 @@
#' using a Meeting Query with core WpA variables as an input.
#'
#' @param data Meeting Query data frame. Must contain the variables `Attendee` and `DurationHours`
#' @param return Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @param return String specifying what to return. This must be one of the
#' following strings:
#' - `"plot"`
#' - `"table"`
#'
#' See `Value` for more information.
#'
#' @import ggplot2
#' @import dplyr
#' @importFrom stats setNames
#'
#' @inherit meetingtype_dist return
#'
#' @family Visualization
#' @family Meetings
#'
#' @export
meetingtype_dist_mt <- function(data, return = "plot"){

35
R/meetingtype_summary.R
Просмотреть файл

@ -1,10 +1,12 @@
#' @title Create a summary bar chart of the proportion of Meeting Hours spent in Long or Large Meetings
#' @title Create a summary bar chart of the proportion of Meeting Hours spent in
#' Long or Large Meetings
#'
#' @description
#' This function creates a bar chart showing the percentage of meeting hours which are spent in
#' long or large meetings.
#' This function creates a bar chart showing the percentage of meeting hours
#' which are spent in long or large meetings.
#'
#' @param data Ways of Working Assessment query in the form of a data frame. Requires the following variables:
#' @param data Ways of Working Assessment query in the form of a data frame.
#' Requires the following variables:
#' - `Bloated_meeting_hours`
#' - `Lengthy_meeting_hours`
#' - `Workshop_meeting_hours`
@ -12,15 +14,22 @@
#' - `Status_update_meeting_hours`
#' - `Decision_making_meeting_hours`
#' - `One_on_one_meeting_hours`
#'
#' @param hrvar HR Variable by which to split metrics, 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 Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @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"`
#'
#' See `Value` for more information.
#'
#' @import ggplot2
#' @import dplyr
#'
#' @family Visualization
#' @family Meetings
#'
#' @export
@ -29,6 +38,12 @@ meetingtype_summary <- function(data,
mingroup = 5,
return = "plot"){
## Handling NULL values passed to hrvar
if(is.null(hrvar)){
data <- totals_col(data)
hrvar <- "Total"
}
mt_dist_str <- c("Bloated_meeting_hours",
"Lengthy_meeting_hours",
"Workshop_meeting_hours",
@ -55,6 +70,7 @@ meetingtype_summary <- function(data,
select(!!sym(hrvar), MeetingHoursInLongOrLargeMeetings, n)
if(return == "plot"){
returnTable %>%
create_bar_asis(group_var = hrvar,
bar_var = "MeetingHoursInLongOrLargeMeetings",
@ -63,10 +79,15 @@ meetingtype_summary <- function(data,
caption = extract_date_range(data, return = "text"),
percent = TRUE,
bar_colour = "alert")
} else if(return == "table"){
returnTable
} else {
stop("Please enter a valid input for `return`.")
}
}

67
R/mgrcoatt_dist.R
Просмотреть файл

@ -10,11 +10,21 @@
#' Returns a stacked bar plot of different buckets of coattendance.
#' Additional options available to return a table with distribution elements.
#'
#' @param data A Standard Person Query dataset in the form of a data frame.
#' @param hrvar HR Variable by which to split metrics. Accepts a character vector, defaults to "Organization" but accepts any character vector, e.g. "LevelDesignation"
#' @param mingroup Numeric value setting the privacy threshold / minimum group size, defaults to 5.
#' @param return Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @template spq-params
#'
#' @param return String specifying what to return. This must be one of the
#' following strings:
#' - `"plot"`
#' - `"table"`
#'
#' See `Value` for more information.
#'
#' @return
#' A different output is returned depending on the value passed to the `return`
#' argument:
#' - `"plot"`: ggplot object. A stacked bar plot showing the distribution of
#' manager co-attendance time.
#' - `"table"`: data frame. A summary table for manager co-attendance time.
#'
#' @import dplyr
#' @import ggplot2
@ -23,14 +33,22 @@
#' @importFrom stats median
#' @importFrom stats sd
#'
#' @family Visualization
#' @family Managerial Relations
#' @family Meeting Culture
#'
#' @examples
#' workloads_dist(sq_data, hrvar = "Organization", return = "table")
#' # Return plot
#' mgrcoatt_dist(sq_data, hrvar = "Organization", return = "plot")
#'
#' # Return summary table
#' mgrcoatt_dist(sq_data, hrvar = "Organization", return = "table")
#'
#' @export
mgrcoatt_dist <- function(data, hrvar = "Organization", mingroup = 5, return = "plot") {
mgrcoatt_dist <- function(data,
hrvar = "Organization",
mingroup = 5,
return = "plot") {
myPeriod <-
data %>%
@ -56,10 +74,11 @@ myPeriod <-
## Create buckets of coattendance time
plot_data <-
plot_data %>%
mutate(bucket_coattendman_rate = case_when(coattendman_rate>=0 & coattendman_rate<.20 ~ "0 - 20%",
coattendman_rate>=.20 & coattendman_rate<.4 ~ "20 - 40%",
coattendman_rate>=.40 & coattendman_rate<.6 ~ "40 - 60%",
coattendman_rate>=.6 ~ "60% +"))
mutate(bucket_coattendman_rate =
case_when(coattendman_rate>=0 & coattendman_rate<.20 ~ "0 - 20%",
coattendman_rate>=.20 & coattendman_rate<.4 ~ "20 - 40%",
coattendman_rate>=.40 & coattendman_rate<.6 ~ "40 - 60%",
coattendman_rate>=.6 ~ "60% +"))
## Employee count / base size table
@ -74,7 +93,8 @@ myPeriod <-
plot_data %>%
group_by(group, bucket_coattendman_rate) %>%
summarize(Employees=n(),
Employee_Count=first(Employee_Count), percent= Employees / Employee_Count) %>%
Employee_Count=first(Employee_Count),
percent= Employees / Employee_Count) %>%
arrange(group, bucket_coattendman_rate)
## Table for annotation
@ -89,14 +109,25 @@ myPeriod <-
geom_bar(stat = "identity", position = position_fill(reverse = TRUE)) +
coord_flip() +
scale_y_continuous(labels = function(x) paste0(x*100, "%")) +
annotate("text", x = plot_legend$group, y = -.05, label = plot_legend$Employee_Count ) +
scale_fill_manual(name="", values = c("#bed6f2", "#e9f1fb","#ffdfd3","#FE7F4F")) +
annotate("text",
x = plot_legend$group,
y = -.05,
label = plot_legend$Employee_Count) +
scale_fill_manual(name="",
values = c("#bed6f2",
"#e9f1fb",
"#ffdfd3",
"#FE7F4F")) +
theme_classic() +
theme(axis.text=element_text(size=12),
plot.title = element_text(color="grey40", face="bold", size=18),
plot.subtitle = element_text(size=14), legend.position = "top", legend.justification = "right",
legend.title=element_text(size=14), legend.text=element_text(size=14)) +
labs(title = "Time with Manager", subtitle = paste("Meeting Co-attendance Rate by", hrvar)) +
plot.subtitle = element_text(size=14),
legend.position = "top",
legend.justification = "right",
legend.title=element_text(size=14),
legend.text=element_text(size=14)) +
labs(title = "Time with Manager",
subtitle = paste("Meeting Co-attendance Rate by", hrvar)) +
xlab(hrvar) +
ylab("Fraction of Employees") +
labs(caption = paste("Data from week of", myPeriod$Start, "to week of", myPeriod$End))

4
R/mt_data.R
Просмотреть файл

@ -6,7 +6,9 @@
#' @title Sample Meeting Query dataset
#'
#' @description
#' A dataset generated from a Meeting Query from WpA.
#' A dataset generated from a Meeting Query from Workplace Analytics.
#'
#' @family Data
#'
#' @format A data frame with 2001 rows and 30 variables:
#' \describe{

5
R/one2one_dist.R
Просмотреть файл

@ -13,14 +13,15 @@
#' @inheritParams create_dist
#' @inherit create_dist return
#'
#' @family Visualization
#' @family Managerial Relations
#'
#' @examples
#' # Return plot
#' workloads_dist(sq_data, hrvar = "Organization", return = "plot")
#' one2one_dist(sq_data, hrvar = "Organization", return = "plot")
#'
#' # Return summary table
#' workloads_dist(sq_data, hrvar = "Organization", return = "table")
#' one2one_dist(sq_data, hrvar = "Organization", return = "table")
#' @export
one2one_dist <- function(data,

4
R/one2one_fizz.R
Просмотреть файл

@ -10,12 +10,10 @@
#' a 'fizzy' scatter plot by default.
#' Additional options available to return a table with distribution elements.
#'
#' @details
#' Uses the metric `After_hours_collaboration_hours`.
#'
#' @inheritParams create_fizz
#' @inherit create_fizz return
#'
#' @family Visualization
#' @family Managerial Relations
#'
#' @examples

1
R/one2one_line.R
Просмотреть файл

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

10
R/one2one_rank.R
Просмотреть файл

@ -6,20 +6,20 @@
#' @title Manager 1:1 Time Ranking
#'
#' @description
#' This function scans a standard query output for groups with high levels of 'Manager 1:1 Time'.
#' Returns a table with a all of groups (across multiple HR attributes) ranked by hours of digital collaboration.
#' This function scans a standard query output for groups with high levels of
#' 'Manager 1:1 Time'. Returns a table with a all of groups (across multiple HR
#' attributes) ranked by hours of digital collaboration.
#'
#' @details
#' Uses the metric `Meeting_hours_with_manager_1_on_1`.
#' See `create_rank()` for applying the same analysis to a different metric.
#'
#' @inheritParams create_rank
#' @inherit create_rank return
#'
#'
#' @family Visualization
#' @family Managerial Relations
#'
#' @return
#' When 'table' is passed in `return`, a summary table is returned as a data frame.
#'
#' @export

7
R/one2one_sum.R
Просмотреть файл

@ -6,13 +6,14 @@
#' @title Manager 1:1 Time Summary
#'
#' @description
#' Provides an overview analysis of Manager 1:1 Time.
#' Returns a bar plot showing average weekly minutes of Manager 1:1 Time by default.
#' Additional options available to return a summary table.
#' Provides an overview analysis of Manager 1:1 Time. Returns a bar plot showing
#' average weekly minutes of Manager 1:1 Time by default. Additional options
#' available to return a summary table.
#'
#' @inheritParams create_bar
#' @inherit create_bar return
#'
#' @family Visualization
#' @family Managerial Relations
#'
#' @examples

11
R/one2one_trend.R
Просмотреть файл

@ -6,20 +6,19 @@
#' @title Manager 1:1 Time Trend
#'
#' @description
#' Provides a week by week view of scheduled manager 1:1 Time.
#' By defualt returns a week by week heatmap, highlighting the points in time with most activity.
#' Additional options available to return a summary table.
#' Provides a week by week view of scheduled manager 1:1 Time. By default
#' returns a week by week heatmap, highlighting the points in time with most
#' activity. Additional options available to return a summary table.
#'
#' @details
#' Uses the metric `Meeting_hours_with_manager_1_on_1`.
#'
#' @inheritParams create_trend
#' @inherit create_trend return
#'
#' @family Visualization
#' @family Managerial Relations
#'
#' @return
#' Returns a ggplot object by default, where 'plot' is passed in `return`.
#' When 'table' is passed, a summary table is returned as a data frame.
#'
#' @export

18
R/p_test.R
Просмотреть файл

@ -3,17 +3,23 @@
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
#' @title Calculate the p-value of the null hypothesis that two outcomes are from the same dataset
#' @title
#' Calculate the p-value of the null hypothesis that two outcomes are from the
#' same dataset
#'
#' @description
#' Specify an outcome variable and return p-test outputs.
#' All numeric variables in the dataset are used as predictor variables.
#'
#' @param data A Person Query dataset in the form of a data frame.
#' @param outcome A string specifying a binary variable, i.e. can only contain
#' the values 1 or 0. Used to group the two distributions.
#' @param behavior A character vector specifying the column to be used as the behavior to test.
#' @param paired Specify whether the dataset is paired or not. Defaults to TRUE.
#' @param outcome A string specifying the name of a binary variable, i.e. can
#' only contain the values 1 or 0. Used to group the two distributions.
#' @param behavior A character vector specifying the column to be used as the
#' behavior to test.
#' @param paired Specify whether the dataset is paired or not. Defaults to
#' `TRUE`.
#'
#' @family Support
#'
#' @import dplyr
#'
@ -27,11 +33,13 @@
#' sq_data %>%
#' mutate(X = ifelse(Email_hours > 6, 1, 0)) %>%
#' p_test(outcome = "X", behavior = "External_network_size")
#'
#' @export
p_test <- function(data,
outcome,
behavior,
paired = FALSE){
train <- data %>%
dplyr::filter(!!sym(outcome) == 1 | !!sym(outcome) == 0) %>%
select(!!sym(outcome), !!sym(behavior)) %>%

13
R/pairwise_count.R
Просмотреть файл

@ -1,15 +1,18 @@
#' @title Perform a pairwise count of words by id
#'
#' @description This is a **data.table** implementation that mimics the output of
#' `widyr::pairwise_count()` to reduce package dependency. This is used internally
#' within `tm_cooc()`.
#' @description This is a 'data.table' implementation that mimics the output
#' of `widyr::pairwise_count()` to reduce package dependency. This is used
#' internally within `tm_cooc()`.
#'
#' @param data Data frame output from `tm_clean()`.
#' @param id String to represent the id variable. Defaults to "line".
#' @param word String to represent the word variable. Defaults to "word".
#' @param id String to represent the id variable. Defaults to `"line"`.
#' @param word String to represent the word variable. Defaults to `"word"`.
#'
#' @importFrom data.table ":=" "%like%" "%between%" rbindlist as.data.table
#'
#' @family Support
#' @family Text-mining
#'
#' @examples
#' td <- data.frame(line = c(1, 1, 2, 2),
#' word = c("work", "meeting", "catch", "up"))

32
R/period_change.R
Просмотреть файл

@ -10,16 +10,24 @@
#' This function also presents the p-value for the null hypothesis
#' that the variable has not changed, using a Wilcox signed-rank test.
#'
#' @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.
#' @param compvar WpA comparison variable to compare person change before and after
#' For example, "Collaboration_hours"
#' @param before_start Start date of "before" time period in YYYY-MM-DD
#' @param before_end End date of "before" time period in YYYY-MM-DD
#' @param after_start Start date of "after" time period in YYYY-MM-DD
#' @param after_end End date of "after" time period in YYYY-MM-DD
#' @param return Character vector specifying whether to return plot as Count or Percentage of Employees
#' Valid inputs include "count" (default), "percentage", and "table".
#' @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.
#' @param compvar WpA comparison variable to compare person change before and
#' after For example, `"Collaboration_hours"`
#' @param before_start Start date of "before" time period in `YYYY-MM-DD`
#' @param before_end End date of "before" time period in `YYYY-MM-DD`
#' @param after_start Start date of "after" time period in `YYYY-MM-DD`
#' @param after_end End date of "after" time period in `YYYY-MM-DD`
#' @param return Character vector specifying whether to return plot as Count or
#' Percentage of Employees. Valid inputs include:
#' - "count" (default)
#' - "percentage"
#' - "table"
#'
#' @return
#' ggplot object showing a bar plot (histogram) of change for two time
#' intervals.
#'
#' @import dplyr
#' @import reshape2
@ -27,6 +35,10 @@
#' @import scales
#' @importFrom stats wilcox.test
#'
#' @family Visualization
#' @family Time-series
#' @family Flexible
#'
#' @examples
#' # Run plot
#' period_change(sq_data, compvar = "Workweek_span", before_end = "2019-11-16")

2
R/personas_hclust.R
Просмотреть файл

@ -45,6 +45,8 @@
#' @importFrom stats cutree
#' @importFrom tidyr replace_na
#'
#' @family Clustering
#'
#' @examples
#' # Return plot
#' personas_hclust(sq_data,

17
R/remove_outliers.R
Просмотреть файл

@ -7,14 +7,16 @@
#'
#' @description
#' `r lifecycle::badge('experimental')`
#' This function takes in a selected metric and uses z-score (number of standard
#' deviations) to identify and remove outlier weeks for individuals across time. There are applications
#' in this for removing weeks with abnormally low collaboration
#' activity, e.g. holidays. Retains metrics with z > -2.
#'
#' Function is based on `identify_outlier()`, but implements a more elaborate approach as the outliers are
#' identified and removed **with respect to each individual**, as opposed to the group. Note that `remove_outliers()`
#' has a longer runtime compared to `identify_outlier()`.
#' This function takes in a selected metric and uses z-score (number of standard
#' deviations) to identify and remove outlier weeks for individuals across time.
#' There are applications in this for removing weeks with abnormally low
#' collaboration activity, e.g. holidays. Retains metrics with z > -2.
#'
#' Function is based on `identify_outlier()`, but implements a more elaborate
#' approach as the outliers are identified and removed **with respect to each
#' individual**, as opposed to the group. Note that `remove_outliers()` has a
#' longer runtime compared to `identify_outlier()`.
#'
#' @details
#' For mature functions to remove common outliers, please see the following:
@ -27,6 +29,7 @@
#' e.g. "Collaboration_hours"
#'
#' @import dplyr
#'
#' @family Data Validation
#'
#' @return

4
R/sq_data.R
Просмотреть файл

@ -6,7 +6,9 @@
#' @title Sample Standard Person Query dataset
#'
#' @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 13442 rows and 66 variables:
#' \describe{

6
R/standardise_pq.R
Просмотреть файл

@ -15,7 +15,11 @@
#' - `Collaboration_hrs` -> `Collaboration_hours`
#' - `Instant_message_hours` -> `Instant_Message_hours`
#'
#' @param data A Ways of Working Assessment query to pass through as a data frame.
#' @param data A Ways of Working Assessment query to pass through as a data
#' frame.
#'
#' @family Data Validation
#' @family Import and Export
#'
#' @export
standardise_pq <- function(data){

26
R/subject_validate.r
Просмотреть файл

@ -6,23 +6,27 @@
#' @title Scan meeting subject and highlight items for review
#'
#' @description
#' This functions scans a meeting query and highlights meetings with subjects that include common exlusion terms. It is intended to be used by an analyst to validate raw data before conducting additional analysis.
#' Returns a summary in the console by default.
#' Additional option to return the underlying data with a flag of items for review.
#' This functions scans a meeting query and highlights meetings with subjects
#' that include common exlusion terms. It is intended to be used by an analyst
#' to validate raw data before conducting additional analysis. Returns a summary
#' in the console by default. Additional option to return the underlying data
#' with a flag of items for review.
#'
#'
#' @family Data Validation
#' @family Text-mining
#'
#' @param data A meeting query in the form of a data frame.
#' @param return A string specifying what to return.
#' Returns a message in the console by default, where 'text' is passed in `return`.
#' When 'table' is passed, a summary table with common terms found is printed.
#' When 'data' is passed, a the original data with an additional flag column is returned as a data frame.
#' @param return A string specifying what to return. Returns a message in the
#' console by default, where `'text'` is passed in `return`. When `'table'` is
#' passed, a summary table with common terms found is printed. When `'data'`
#' is passed, a the original data with an additional flag column is returned
#' as a data frame.
#'
#' @return
#' Returns a message in the console by default, where 'text' is passed in `return`.
#' When 'table' is passed, a summary table with common terms found is printed.
#' When 'data' is passed, a the original data with an additional flag column is returned as a data frame.
#' @return Returns a message in the console by default, where `'text'` is passed
#' in `return`. When `'table'` is passed, a summary table with common terms
#' found is printed. When `'data'` is passed, a the original data with an
#' additional flag column is returned as a data frame.
#'
#' @export

16
R/subject_validate_report.R
Просмотреть файл

@ -5,19 +5,21 @@
#' @title Generate Meeting Text Mining report in HTML for Common Exclusion Terms
#'
#' @description
#' This functions creates a text mining report in HTML based on Meeting Subject Lines for data validation. It scans a meeting query and highlights meetings with subjects that include common exlusion terms. It is intended to be used by an analyst to validate raw data before conducting additional analysis.
#' Returns a HTML report by default.
#' @description This functions creates a text mining report in HTML based on
#' Meeting Subject Lines for data validation. It scans a meeting query and
#' highlights meetings with subjects that include common exlusion terms. It is
#' intended to be used by an analyst to validate raw data before conducting
#' additional analysis. Returns a HTML report by default.
#'
#' @family Data Validation
#' @family Text-mining
#' @family Reports
#'
#' @param data A Meeting Query dataset in the form of a data frame.
#' @param path Pass the file path and the desired file name, _excluding the file extension_.
#' For example, "meeting text mining report".
#' @param timestamp Logical vector specifying whether to include a timestamp in the file name.
#' Defaults to TRUE.
#' @param path Pass the file path and the desired file name, _excluding the file
#' extension_. For example, `"meeting text mining report"`.
#' @param timestamp Logical vector specifying whether to include a timestamp in
#' the file name. Defaults to `TRUE`.
#' @param keep A numeric vector specifying maximum number of words to keep.
#' @param seed A numeric vector to set seed for random generation.
#'

6
R/themes.R
Просмотреть файл

@ -14,13 +14,14 @@
#' base font size. Defaults to 12.
#'
#' @param font_family Character value specifying the font family
#' to be used in the plot. The default value is "Segoe UI". To ensure
#' to be used in the plot. The default value is `"Segoe UI"`. To ensure
#' you can use this font, install and load {extrafont} prior to
#' plotting. There is an initialisation process that is described by:
#' https://stackoverflow.com/questions/34522732/changing-fonts-in-ggplot2
#' <https://stackoverflow.com/questions/34522732/changing-fonts-in-ggplot2>
#'
#' @import ggplot2
#'
#' @family Themes
#'
#' @export
theme_wpa <- function(font_size = 12, font_family = "Segoe UI"){
@ -73,6 +74,7 @@ theme_wpa <- function(font_size = 12, font_family = "Segoe UI"){
#'
#' @import ggplot2
#'
#' @family Themes
#'
#' @export
theme_wpa_basic <- function(font_size = 12){

18
R/tm_clean.R
Просмотреть файл

@ -6,17 +6,19 @@
#' @title Clean subject line text prior to analysis
#'
#' @description
#' This function processes the `Subject` column in a Meeting Query by
#' applying tokenisation using`tidytext::unnest_tokens()`, and removing
#' any stopwords supplied in a data frame (using the argument `stopwords`).
#' This is a sub-function that feeds into `tm_freq()`, `tm_cooc()`, and `tm_wordcloud()`.
#' The default is to return a data frame with tokenised counts of words or ngrams.
#' This function processes the `Subject` column in a Meeting Query by applying
#' tokenisation using`tidytext::unnest_tokens()`, and removing any stopwords
#' supplied in a data frame (using the argument `stopwords`). This is a
#' sub-function that feeds into `tm_freq()`, `tm_cooc()`, and `tm_wordcloud()`.
#' The default is to return a data frame with tokenised counts of words or
#' ngrams.
#'
#'
#' @param data A Meeting Query dataset in the form of a data frame.
#' @param token A character vector accepting either "words" or "ngram", determining
#' type of tokenisation to return.
#' @param stopwords A single-column data frame labelled 'word' containing custom stopwords to remove.
#' @param token A character vector accepting either `"words"` or `"ngram"`,
#' determining type of tokenisation to return.
#' @param stopwords A single-column data frame labelled `'word'` containing
#' custom stopwords to remove.
#'
#' @import dplyr
#' @import ggplot2

22
R/tm_cooc.R
Просмотреть файл

@ -3,24 +3,26 @@
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
#' @title Analyse word co-occurrence in subject lines and return a network plot
#' @title
#' 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 return a table.
#' This is a sub-function that feeds into `meeting_tm_report()`.
#' This function generates a word co-occurence network plot, with options to
#' return a table. This is a sub-function that feeds into `meeting_tm_report()`.
#'
#' @details
#' This function uses `tm_clean()` as the underlying data wrangling function.
#' There is an option to remove stopwords by passing a data frame into the `stopwords`
#' argument.
#' There is an option to remove stopwords by passing a data frame into the
#' `stopwords` argument.
#'
#' @param data A Meeting Query dataset in the form of a data frame.
#' @param stopwords A single-column data frame labelled 'word' containing custom stopwords to remove.
#' @param stopwords A single-column data frame labelled 'word' containing custom
#' stopwords to remove.
#' @param seed A numeric vector to set seed for random generation.
#' @param return Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @param lmult A multiplier to adjust the line width in the output plot. Defaults to 0.05.
#' @param return Character vector specifying what to return, defaults to
#' `"plot"`. Valid inputs are `"plot"` and `"table"`.
#' @param lmult A multiplier to adjust the line width in the output plot.
#' Defaults to 0.05.
#'
#' @import dplyr
#' @import ggplot2

17
R/tm_freq.R
Просмотреть файл

@ -11,24 +11,23 @@
#'
#' @details
#' This function uses `tm_clean()` as the underlying data wrangling function.
#' There is an option to remove stopwords by passing a data frame into the `stopwords`
#' argument.
#' There is an option to remove stopwords by passing a data frame into the
#' `stopwords` argument.
#'
#' @param data A Meeting Query dataset in the form of a data frame.
#' @param token A character vector accepting either "words" or "ngram", determining
#' type of tokenisation to return.
#' @param stopwords A single-column data frame labelled 'word' containing custom stopwords to remove.
#' @param token A character vector accepting either `"words"` or `"ngram"`,
#' determining type of tokenisation to return.
#' @param stopwords A single-column data frame labelled `'word'` containing
#' custom stopwords to remove.
#' @param keep A numeric vector specifying maximum number of words to keep.
#' @param return Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @param return Character vector specifying what to return, defaults to
#' `"plot"`. Valid inputs are `"plot"` and `"table"`.
#'
#' @import dplyr
#' @import ggplot2
#' @importFrom tidytext unnest_tokens
#' @importFrom stats na.omit
#'
#' @examples
#' tm_freq(mt_data)
#'
#' @examples
#' tm_freq(mt_data, token = "words")

13
R/tm_wordcloud.R
Просмотреть файл

@ -17,16 +17,19 @@
#'
#' @details
#' This function uses `tm_clean()` as the underlying data wrangling function.
#' There is an option to remove stopwords by passing a data frame into the `stopwords`
#' argument.
#' There is an option to remove stopwords by passing a data frame into the
#' `stopwords` argument.
#'
#' @param data A Meeting Query dataset in the form of a data frame.
#' @param stopwords A single-column data frame labelled 'word' containing custom stopwords to remove.
#' @param stopwords A single-column data frame labelled `'word'` containing
#' custom stopwords to remove.
#' @param seed A numeric vector to set seed for random generation.
#' @param keep A numeric vector specifying maximum number of words to keep.
#' @param return Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table". A "table" returns the data used to generate the wordcloud.
#' @param ... Additional parameters to be passed to `ggwordcloud::geom_text_wordcloud()`#'
#' Valid inputs are "plot" and "table". A "table" returns the data used to
#' generate the wordcloud.
#' @param ... Additional parameters to be passed to
#' `ggwordcloud::geom_text_wordcloud()`
#'
#' @import dplyr
#' @examples

10
R/totals_bind.R
Просмотреть файл

@ -16,10 +16,12 @@
#' collab_sum(hrvar = "LevelDesignation", return = "table")
#'
#' @param data data frame
#' @param target_col Character value of the column in which to impute "Total".
#' This is usually the intended grouping column.
#' @param target_value Character value to impute in the new data frame to row-bind.
#' Defaults to "Total".
#' @param target_col Character value of the column in which to impute `"Total"`.
#' This is usually the intended grouping column.
#' @param target_value Character value to impute in the new data frame to
#' row-bind. Defaults to `"Total"`.
#'
#' @family Support
#'
#' @export
totals_bind <- function(data, target_col, target_value = "Total"){

15
R/totals_col.R
Просмотреть файл

@ -5,9 +5,10 @@
#' @title Fabricate a 'Total' HR variable
#'
#' @description Create a 'Total' column of character type comprising exactly of one unique value.
#' This is a convenience function for returning a no-HR attribute view when NULL is supplied to
#' the `hrvar` argument in functions.
#' @description Create a 'Total' column of character type comprising exactly of
#' one unique value. This is a convenience function for returning a no-HR
#' attribute view when `NULL` is supplied to the `hrvar` argument in
#' functions.
#'
#' @examples
#' # Create a visual without HR attribute breaks
@ -16,9 +17,11 @@
#' collab_fizz(hrvar = "Total")
#'
#' @param data data frame
#' @param total_value Character value defining the name and the value of the "Total" column.
#' Defaults to "Total". An error is returned if an existing variable has the same name as the
#' supplied value.
#' @param total_value Character value defining the name and the value of the
#' `"Total"` column. Defaults to `"Total"`. An error is returned if an
#' existing variable has the same name as the supplied value.
#'
#' @family Support
#'
#' @export
totals_col <- function(data, total_value = "Total"){

12
R/totals_reorder.R
Просмотреть файл

@ -5,11 +5,11 @@
#' @title Reorder a value to the top of the summary table
#'
#' @description For a given data frame, reorder a row to the first row
#' of that data frame through matching a _value_ of a _variable_. The intended
#' usage of this function is to be used for reordering the "Total" row,
#' and _not_ with "flat" data. This can be used in conjunction with `totals_bind()`,
#' which is used to create a "Total" row in the data.
#' @description For a given data frame, reorder a row to the first row of that
#' data frame through matching a _value_ of a _variable_. The intended usage
#' of this function is to be used for reordering the "Total" row, and _not_
#' with "flat" data. This can be used in conjunction with `totals_bind()`,
#' which is used to create a "Total" row in the data.
#'
#' @examples
#' sq_data %>%
@ -23,6 +23,8 @@
#' @param target_col Character value of the column in which to reorder
#' @param target_value Character value of the value in `target_col` to match
#'
#' @family Support
#'
#' @export
totals_reorder <- function(data, target_col, target_value = "Total"){
tc <- unique(data[[target_col]])

26
R/track_hr_change.R
Просмотреть файл

@ -3,32 +3,38 @@
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
#' @title Sankey chart of org between HR attributes (Defaults to Organization) and NA (outside company move) (Data Overview)
#' @title Sankey chart of organizational movement between HR attributes and
#' missing values (outside company move) (Data Overview)
#'
#' @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.
#' then aggregates up people who have moved between orgs between this to points
#' of time and visualiazes 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
#' - The number of people that do not have that HR attribute ot they are no longer in the system
#' - The number of people that do not have that HR attribute ot they are no
#' longer in the system
#'
#' @param data A Person Query dataset in the form of a data frame.
#' @param start_date A start date to compare changes. See `end_date`.
#' @param end_date An end date to compare changes. See `start_date`.
#' @param hrvar HR Variable by which to compare changes between, 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 Character vector specifying what to return, defaults to "plot".
#' Valid inputs are "plot" and "table".
#' @param NA_replacement Character replacement for NA defaults to "out of company"
#' @param hrvar HR Variable by which to compare changes between, 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 Character vector specifying what to return, defaults to
#' `"plot"`. Valid inputs are `"plot"` and `"table"`.
#' @param NA_replacement Character replacement for NA defaults to "out of
#' company"
#'
#' @import dplyr
#'
#' @family Data Validation
#'
#' @return
#' Returns a NetworkD3 object by default, where 'plot' is passed in `return`.
#' Returns a 'NetworkD3' object by default, where 'plot' is passed in `return`.
#' When 'table' is passed, a summary table is returned as a data frame.
#'
#' @examples

3
R/tstamp.R
Просмотреть файл

@ -6,9 +6,10 @@
#' @title Generate a time stamp
#'
#' @description
#' This function generates a time stamp of the format yymmdd_hhmmss.
#' This function generates a time stamp of the format `yymmdd_hhmmss`.
#' This is a support function and is not intended for direct use.
#'
#' @family Support
#'
#' @export
tstamp <- function(){

2
R/us_to_space.R
Просмотреть файл

@ -4,6 +4,8 @@
#'
#' @param x String to replace all occurrences of `_` with a single space
#'
#' @family Support
#'
#' @examples
#' us_to_space("Meeting_hours_with_manager_1_on_1")
#'

35
R/validation_report.R
Просмотреть файл

@ -11,17 +11,18 @@
#' Workplace Analytics query outputs to provide diagnostic information
#' for the Analyst prior to analysis.
#'
#' An additional Standard Meeting Query can be provided to perform meeting subject line
#' related checks. This is optional and the validation report can be run without it.
#' An additional Standard Meeting Query can be provided to perform meeting
#' subject line related checks. This is optional and the validation report can
#' be run without it.
#'
#' @details
#' For your input to `data` or `meeting_data`, please use the function `wpa::import_wpa()`
#' to import your csv query files into R. This function will standardize format
#' and prepare the data as input for this report.
#' For your input to `data` or `meeting_data`, please use the function
#' `wpa::import_wpa()` to import your csv query files into R. This function will
#' standardize format and prepare the data as input for this report.
#'
#' If you are passing a Ways of Working Assessment query instead of a Standard Person query
#' to the `data` argument, please also use `standardise_pq()` to make the variable names
#' consistent with a Standard Person Query.
#' If you are passing a Ways of Working Assessment query instead of a Standard
#' Person query to the `data` argument, please also use `standardise_pq()` to
#' make the variable names consistent with a Standard Person Query.
#'
#' @section Checking functions within `validation_report()`:
#' - `check_query()`
@ -39,15 +40,17 @@
#' You can browse each individual function for details on calculations.
#'
#' @param data A Standard Person Query dataset in the form of a data frame.
#' @param meeting_data An optional Meeting Query dataset in the form of a data frame.
#' @param meeting_data An optional Meeting Query dataset in the form of a data
#' frame.
#' @param hrvar HR Variable by which to split metrics, defaults to "Organization"
#' but accepts any character vector, e.g. "Organization"
#' @param path Pass the file path and the desired file name, _excluding the file extension_.
#' @param hrvar_threshold Numeric value determining the maximum number of unique values
#' to be allowed to qualify as a HR variable. This is passed directly to the `threshold`
#' argument within `hrvar_count_all()`.
#' @param timestamp Logical vector specifying whether to include a timestamp in the file name.
#' Defaults to TRUE.
#' @param path Pass the file path and the desired file name, _excluding the file
#' extension_.
#' @param hrvar_threshold Numeric value determining the maximum number of unique
#' values to be allowed to qualify as a HR variable. This is passed directly
#' to the `threshold` argument within `hrvar_count_all()`.
#' @param timestamp Logical vector specifying whether to include a timestamp in
#' the file name. Defaults to `TRUE`.
#'
#' @examples
#' \donttest{
@ -61,6 +64,8 @@
#' @importFrom dplyr `%>%`
#'
#' @family Reports
#' @family Data Validation
#'
#' @inherit generate_report return
#'
#' @export

3
R/workloads_dist.R
Просмотреть файл

@ -13,7 +13,8 @@
#' @inheritParams create_dist
#' @inherit create_dist return
#'
#' @family Workloads
#' @family Visualization
#' @family Workweek Span
#'
#' @examples
#' # Return plot

3
R/workloads_fizz.R
Просмотреть файл

@ -13,7 +13,8 @@
#' @inheritParams create_fizz
#' @inherit create_fizz return
#'
#' @family Workloads
#' @family Visualization
#' @family Workweek Span
#'
#' @examples
#' # Return plot

3
R/workloads_line.R
Просмотреть файл

@ -14,7 +14,8 @@
#' @inheritParams create_line
#' @inherit create_line return
#'
#' @family Workloads
#' @family Visualization
#' @family Workweek Span
#'
#' @examples
#' # Return a line plot

11
R/workloads_rank.R
Просмотреть файл

@ -6,19 +6,20 @@
#' @title Rank all groups across HR attributes for Work Week Span
#'
#' @description
#' This function scans a standard query output for groups with high levels of Work Week Span.
#' Returns a table with a all of groups (across multiple HR attributes) ranked by work week span.
#' This function scans a standard query output for groups with high levels of
#' Work Week Span. Returns a table with a all of groups (across multiple HR
#' attributes) ranked by work week span.
#'
#' @details
#' Uses the metric `Workweek_span`.
#' See `create_rank()` for applying the same analysis to a different metric.
#'
#' @inheritParams create_rank
#' @inherit create_rank return
#'
#' @family Workloads
#' @family Visualization
#' @family Workweek Span
#'
#' @return
#' When 'table' is passed in `return`, a summary table is returned as a data frame.
#'
#' @export

7
R/workloads_summary.R
Просмотреть файл

@ -11,12 +11,11 @@
#' Additional options available to return a summary table.
#'
#' @inheritParams create_bar
#' @inherit create_bar return
#'
#' @family Workloads
#' @family Visualization
#' @family Workweek Span
#'
#' @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.
#'
#' @examples
#' # Return a ggplot bar chart

11
R/workloads_trend.R
Просмотреть файл

@ -7,15 +7,17 @@
#'
#' @description
#' Provides a week by week view of Work Week Span.
#' By default returns a week by week heatmap, highlighting the points in time with most activity.
#' Additional options available to return a summary table.
#' By default returns a week by week heatmap, highlighting the points in time
#' with most activity. Additional options available to return a summary table.
#'
#' @details
#' Uses the metric `Workweek_span`.
#'
#' @inheritParams create_trend
#' @inherit create_trend return
#'
#' @family Workloads
#' @family Visualization
#' @family Workweek Span
#'
#' @examples
#' # Run plot
@ -24,9 +26,6 @@
#' # Run table
#' workloads_trend(sq_data, hrvar = "LevelDesignation", return = "table")
#'
#' @return
#' Returns a ggplot object by default, where 'plot' is passed in `return`.
#' When 'table' is passed, a summary table is returned as a data frame.
#'
#' @export

19
R/workpatterns_area.R
Просмотреть файл

@ -11,10 +11,12 @@
#'
#' @param data A data frame containing data from the Hourly Collaboration query.
#'
#' @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 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 mingroup Numeric value setting the privacy threshold / minimum group
#' size, defaults to 5.
#'
#' @param signals Character vector to specify which collaboration metrics to
#' use:
@ -25,13 +27,13 @@
#' - `"meetings"` for Meetings only
#'
#' @param return Character vector to specify what to return. Valid options include:
#' - "plot": returns an overlapping area plot (default)
#' - "table": returns a summary table
#' - `"plot"`: returns an overlapping area plot (default)
#' - `"table"`: returns a summary table
#'
#' @param values Character vector to specify whether to return percentages
#' or absolute values in "data" and "plot". Valid values are:
#' - "percent": percentage of signals divided by total signals (default)
#' - "abs": absolute count of signals
#' - `"percent"`: percentage of signals divided by total signals (default)
#' - `"abs"`: absolute count of signals
#'
#' @param start_hour A character vector specifying starting hours,
#' e.g. "0900"
@ -45,6 +47,9 @@
#' @import ggplot2
#' @importFrom tidyr replace_na
#'
#' @family Visualization
#' @family Working Patterns
#'
#' @examples
#' # Return visualization of percentage distribution
#' workpatterns_area(em_data, return = "plot", values = "percent")

5
R/workpatterns_classify.R
Просмотреть файл

@ -8,8 +8,8 @@
#' @description `r lifecycle::badge('experimental')`
#'
#' Apply a rule based algorithm to emails or instant messages sent by hour of
#' day. Uses a binary week-based ('bw') method by default, with options to use the
#' the person-average volume-based ('pav') method.
#' day. Uses a binary week-based ('bw') method by default, with options to use
#' the the person-average volume-based ('pav') method.
#'
#' @details This is a wrapper around `workpatterns_classify_bw()` and
#' `workpatterns_classify_pav()`, and calls each function depending on what is
@ -127,6 +127,7 @@
#'
#' }
#'
#' @family Clustering
#' @family Working Patterns
#'
#' @export

1
R/workpatterns_hclust.R
Просмотреть файл

@ -87,6 +87,7 @@
#'
#' }
#'
#' @family Clustering
#' @family Working Patterns
#'
#' @export

13
R/workpatterns_rank.R
Просмотреть файл

@ -11,13 +11,13 @@
#' least.
#'
#' @param data A data frame containing hourly collaboration data.
#' @param signals Character vector to specify which collaboration metrics to use:
#' You may use "email" (default) for emails only, "IM" for Teams messages only,
#' or a combination of the two `c("email", "IM")`.
#' @param signals Character vector to specify which collaboration metrics to
#' use: You may use `"email"` (default) for emails only, `"IM"` for Teams
#' messages only, or a combination of the two `c("email", "IM")`.
#' @param start_hour A character vector specifying starting hours,
#' e.g. "0900"
#' e.g. "`0900"`
#' @param end_hour A character vector specifying starting hours,
#' e.g. "1700"
#' e.g. `"1700"`
#' @param return String specifying what to return. Defaults to "plot",
#' with options to return a summary table ("table").
#'
@ -26,6 +26,9 @@
#' @examples
#' workpatterns_rank(em_data)
#'
#' @family Visualization
#' @family Working Patterns
#'
#' @export
workpatterns_rank <- function(data,
signals = c("email", "IM"),

3
R/workpatterns_report.R
Просмотреть файл

@ -20,6 +20,9 @@
#'
#' @inherit generate_report return
#'
#' @family Reports
#' @family Working Patterns
#'
#' @importFrom purrr map_if
#' @importFrom methods is
#'

2
R/wrap.R
Просмотреть файл

@ -11,6 +11,8 @@
#' @param string Character string to be wrapped around
#' @param wrapper Character to wrap around `string`
#'
#' @family Support
#'
#' @export
wrap <- function(string, wrapper = '"'){
paste0(wrapper, string, wrapper)

9
man/IV_by_period.Rd
Просмотреть файл

@ -63,17 +63,20 @@ which Workplace Analytics metrics are most explained by the change in dates.
\seealso{
Other Variable Association:
\code{\link{IV_report}()},
\code{\link{create_IV}()}
\code{\link{create_IV}()},
\code{\link{plot_WOE}()}
Other Information Value:
\code{\link{IV_report}()},
\code{\link{create_IV}()}
\code{\link{create_IV}()},
\code{\link{plot_WOE}()}
Other Time-series:
\code{\link{create_line_asis}()},
\code{\link{create_line}()},
\code{\link{create_period_scatter}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Information Value}
\concept{Time-series}

12
man/IV_report.Rd
Просмотреть файл

@ -27,7 +27,7 @@ the values 1 or 0.}
defaults to 10.}
\item{path}{Pass the file path and the desired file name, \emph{excluding the file
extension}. For example, "collaboration report".}
extension}. For example, \code{"IV report"}.}
\item{timestamp}{Logical vector specifying whether to include a timestamp in
the file name. Defaults to TRUE.}
@ -61,16 +61,20 @@ Other Reports:
\code{\link{connectivity_report}()},
\code{\link{generate_report}()},
\code{\link{meeting_tm_report}()},
\code{\link{read_preamble}()},
\code{\link{subject_validate_report}()},
\code{\link{validation_report}()}
\code{\link{validation_report}()},
\code{\link{workpatterns_report}()}
Other Variable Association:
\code{\link{IV_by_period}()},
\code{\link{create_IV}()}
\code{\link{create_IV}()},
\code{\link{plot_WOE}()}
Other Information Value:
\code{\link{IV_by_period}()},
\code{\link{create_IV}()}
\code{\link{create_IV}()},
\code{\link{plot_WOE}()}
}
\concept{Information Value}
\concept{Reports}

31
man/afterhours_dist.Rd
Просмотреть файл

@ -97,7 +97,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other After-hours Collaboration:
\code{\link{afterhours_fizz}()},

31
man/afterhours_fizz.Rd
Просмотреть файл

@ -81,7 +81,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other After-hours Collaboration:
\code{\link{afterhours_dist}()},

31
man/afterhours_line.Rd
Просмотреть файл

@ -85,7 +85,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other After-hours Collaboration:
\code{\link{afterhours_dist}()},

31
man/afterhours_rank.Rd
Просмотреть файл

@ -72,7 +72,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other After-hours Collaboration:
\code{\link{afterhours_dist}()},

31
man/afterhours_summary.Rd
Просмотреть файл

@ -88,7 +88,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other After-hours Collaboration:
\code{\link{afterhours_dist}()},

31
man/afterhours_trend.Rd
Просмотреть файл

@ -74,7 +74,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other After-hours Collaboration:
\code{\link{afterhours_dist}()},

14
man/camel_clean.Rd
Просмотреть файл

@ -28,6 +28,18 @@ Other Support:
\code{\link{extract_hr}()},
\code{\link{heat_colours}()},
\code{\link{is_date_format}()},
\code{\link{rgb2hex}()}
\code{\link{maxmin}()},
\code{\link{md2html}()},
\code{\link{p_test}()},
\code{\link{pairwise_count}()},
\code{\link{plot_WOE}()},
\code{\link{read_preamble}()},
\code{\link{rgb2hex}()},
\code{\link{totals_bind}()},
\code{\link{totals_col}()},
\code{\link{totals_reorder}()},
\code{\link{tstamp}()},
\code{\link{us_to_space}()},
\code{\link{wrap}()}
}
\concept{Support}

14
man/capacity_report.Rd
Просмотреть файл

@ -15,13 +15,15 @@ capacity_report(
\arguments{
\item{data}{A Standard Person Query dataset in the form of a data frame.}
\item{hrvar}{HR Variable by which to split metrics, defaults to "Organization"
but accepts any character vector, e.g. "LevelDesignation"}
\item{hrvar}{String containing the name of the HR Variable by which to split
metrics. Defaults to \code{"Organization"}. To run the analysis on the total
instead of splitting by an HR attribute, supply \code{NULL} (without quotes).}
\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{path}{Pass the file path and the desired file name, \emph{excluding the file extension}.
For example, "capacity report".}
For example, \code{"capacity report"}.}
\item{timestamp}{Logical vector specifying whether to include a timestamp in the file name.
Defaults to TRUE.}
@ -46,7 +48,9 @@ Other Reports:
\code{\link{connectivity_report}()},
\code{\link{generate_report}()},
\code{\link{meeting_tm_report}()},
\code{\link{read_preamble}()},
\code{\link{subject_validate_report}()},
\code{\link{validation_report}()}
\code{\link{validation_report}()},
\code{\link{workpatterns_report}()}
}
\concept{Reports}

14
man/check_inputs.Rd
Просмотреть файл

@ -47,6 +47,18 @@ Other Support:
\code{\link{extract_hr}()},
\code{\link{heat_colours}()},
\code{\link{is_date_format}()},
\code{\link{rgb2hex}()}
\code{\link{maxmin}()},
\code{\link{md2html}()},
\code{\link{p_test}()},
\code{\link{pairwise_count}()},
\code{\link{plot_WOE}()},
\code{\link{read_preamble}()},
\code{\link{rgb2hex}()},
\code{\link{totals_bind}()},
\code{\link{totals_col}()},
\code{\link{totals_reorder}()},
\code{\link{tstamp}()},
\code{\link{us_to_space}()},
\code{\link{wrap}()}
}
\concept{Support}

4
man/check_query.Rd
Просмотреть файл

@ -72,8 +72,10 @@ Other Data Validation:
\code{\link{identify_shifts}()},
\code{\link{identify_tenure}()},
\code{\link{remove_outliers}()},
\code{\link{standardise_pq}()},
\code{\link{subject_validate_report}()},
\code{\link{subject_validate}()},
\code{\link{track_HR_change}()}
\code{\link{track_HR_change}()},
\code{\link{validation_report}()}
}
\concept{Data Validation}

30
man/coaching_report.Rd
Просмотреть файл

@ -15,16 +15,18 @@ coaching_report(
\arguments{
\item{data}{A Standard Person Query dataset in the form of a data frame.}
\item{hrvar}{HR Variable by which to split metrics, defaults to "LevelDesignation"
but accepts any character vector, e.g. "LevelDesignation"}
\item{hrvar}{String containing the name of the HR Variable by which to split
metrics. Defaults to \code{"Organization"}. To run the analysis on the total
instead of splitting by an HR attribute, supply \code{NULL} (without quotes).}
\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{path}{Pass the file path and the desired file name, \emph{excluding the file extension}.
For example, "collaboration report".}
\item{path}{Pass the file path and the desired file name, \emph{excluding the file
extension}. For example, \code{"coaching report"}.}
\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}.}
}
\value{
An HTML report with the same file name as specified in the arguments is
@ -32,11 +34,11 @@ generated in the working directory. No outputs are directly returned by the
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, specifically relating to the time
spent between managers and their direct reports.
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,
specifically relating to the time spent between managers and their direct
reports.
}
\seealso{
Other Reports:
@ -46,7 +48,9 @@ Other Reports:
\code{\link{connectivity_report}()},
\code{\link{generate_report}()},
\code{\link{meeting_tm_report}()},
\code{\link{read_preamble}()},
\code{\link{subject_validate_report}()},
\code{\link{validation_report}()}
\code{\link{validation_report}()},
\code{\link{workpatterns_report}()}
}
\concept{Reports}

31
man/collaboration_area.Rd
Просмотреть файл

@ -94,7 +94,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Collaboration:
\code{\link{collaboration_dist}()},

31
man/collaboration_dist.Rd
Просмотреть файл

@ -105,7 +105,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Collaboration:
\code{\link{collaboration_area}()},

31
man/collaboration_fizz.Rd
Просмотреть файл

@ -87,7 +87,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Collaboration:
\code{\link{collaboration_area}()},

31
man/collaboration_line.Rd
Просмотреть файл

@ -89,7 +89,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Collaboration:
\code{\link{collaboration_area}()},

31
man/collaboration_rank.Rd
Просмотреть файл

@ -80,7 +80,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Collaboration:
\code{\link{collaboration_area}()},

20
man/collaboration_report.Rd
Просмотреть файл

@ -15,15 +15,15 @@ collaboration_report(
\arguments{
\item{data}{A Standard Person Query dataset in the form of a data frame.}
\item{hrvar}{HR Variable by which to split metrics. Defaults to \code{"AUTO"},
where the HR variable with most collaboration variance is automatically
selected. Also accepts any character vector, e.g. "LevelDesignation"}
\item{hrvar}{String containing the name of the HR Variable by which to split
metrics. Defaults to \code{"Organization"}. To run the analysis on the total
instead of splitting by an HR attribute, supply \code{NULL} (without quotes).}
\item{mingroup}{Numeric value setting the privacy threshold / minimum group
size. Defaults to 5.}
\item{path}{Pass the file path and the desired file name, \emph{excluding the file
extension}. For example, "collaboration report".}
extension}. For example, \code{"collaboration report"}.}
\item{timestamp}{Logical vector specifying whether to include a timestamp in
the file name. Defaults to \code{TRUE}.}
@ -34,10 +34,10 @@ generated in the working directory. No outputs are directly returned by the
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{collaboration}
metrics in Workplace Analytics,including email and meeting hours.
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{collaboration} metrics in Workplace
Analytics,including email and meeting hours.
}
\seealso{
Other Reports:
@ -47,7 +47,9 @@ Other Reports:
\code{\link{connectivity_report}()},
\code{\link{generate_report}()},
\code{\link{meeting_tm_report}()},
\code{\link{read_preamble}()},
\code{\link{subject_validate_report}()},
\code{\link{validation_report}()}
\code{\link{validation_report}()},
\code{\link{workpatterns_report}()}
}
\concept{Reports}

31
man/collaboration_sum.Rd
Просмотреть файл

@ -80,7 +80,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Collaboration:
\code{\link{collaboration_area}()},

31
man/collaboration_trend.Rd
Просмотреть файл

@ -74,7 +74,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Collaboration:
\code{\link{collaboration_area}()},

14
man/combine_signals.Rd
Просмотреть файл

@ -42,6 +42,18 @@ Other Support:
\code{\link{extract_hr}()},
\code{\link{heat_colours}()},
\code{\link{is_date_format}()},
\code{\link{rgb2hex}()}
\code{\link{maxmin}()},
\code{\link{md2html}()},
\code{\link{p_test}()},
\code{\link{pairwise_count}()},
\code{\link{plot_WOE}()},
\code{\link{read_preamble}()},
\code{\link{rgb2hex}()},
\code{\link{totals_bind}()},
\code{\link{totals_col}()},
\code{\link{totals_reorder}()},
\code{\link{tstamp}()},
\code{\link{us_to_space}()},
\code{\link{wrap}()}
}
\concept{Support}

29
man/connectivity_report.Rd
Просмотреть файл

@ -15,16 +15,18 @@ connectivity_report(
\arguments{
\item{data}{A Standard Person Query dataset in the form of a data frame.}
\item{hrvar}{HR Variable by which to split metrics, defaults to "Organization"
but accepts any character vector, e.g. "LevelDesignation"}
\item{hrvar}{String containing the name of the HR Variable by which to split
metrics. Defaults to \code{"Organization"}. To run the analysis on the total
instead of splitting by an HR attribute, supply \code{NULL} (without quotes).}
\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{path}{Pass the file path and the desired file name, \emph{excluding the file extension}.
For example, "collaboration report".}
\item{path}{Pass the file path and the desired file name, \emph{excluding the file
extension}. For example, \code{"connectivity report"}.}
\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}.}
}
\value{
An HTML report with the same file name as specified in the arguments is
@ -32,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
Standard Person Query data as an input. The report contains a series
of summary analysis and visualisations relating to key \strong{connectivity}
metrics in Workplace Analytics, including external/internal network size
vs breadth.
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{connectivity} metrics in Workplace
Analytics, including external/internal network size vs breadth.
}
\seealso{
Other Reports:
@ -46,7 +47,9 @@ Other Reports:
\code{\link{collaboration_report}()},
\code{\link{generate_report}()},
\code{\link{meeting_tm_report}()},
\code{\link{read_preamble}()},
\code{\link{subject_validate_report}()},
\code{\link{validation_report}()}
\code{\link{validation_report}()},
\code{\link{workpatterns_report}()}
}
\concept{Reports}

5
man/copy_df.Rd
Просмотреть файл

@ -25,13 +25,14 @@ 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 from
https://www.github.com/martinctc/surveytoolbox.
\url{https://www.github.com/martinctc/surveytoolbox}.
}
\seealso{
Other Import and Export:
\code{\link{create_dt}()},
\code{\link{export}()},
\code{\link{import_to_fst}()},
\code{\link{import_wpa}()}
\code{\link{import_wpa}()},
\code{\link{standardise_pq}()}
}
\concept{Import and Export}

6
man/create_IV.Rd
Просмотреть файл

@ -79,11 +79,13 @@ sq_data \%>\%
\seealso{
Other Variable Association:
\code{\link{IV_by_period}()},
\code{\link{IV_report}()}
\code{\link{IV_report}()},
\code{\link{plot_WOE}()}
Other Information Value:
\code{\link{IV_by_period}()},
\code{\link{IV_report}()}
\code{\link{IV_report}()},
\code{\link{plot_WOE}()}
}
\concept{Information Value}
\concept{Variable Association}

34
man/create_bar.Rd
Просмотреть файл

@ -106,7 +106,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Flexible:
\code{\link{create_bar_asis}()},
@ -122,7 +151,8 @@ Other Flexible:
\code{\link{create_sankey}()},
\code{\link{create_scatter}()},
\code{\link{create_stacked}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Flexible}
\concept{Visualization}

34
man/create_bar_asis.Rd
Просмотреть файл

@ -129,7 +129,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Flexible:
\code{\link{create_bar}()},
@ -145,7 +174,8 @@ Other Flexible:
\code{\link{create_sankey}()},
\code{\link{create_scatter}()},
\code{\link{create_stacked}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Flexible}
\concept{Visualization}

34
man/create_boxplot.Rd
Просмотреть файл

@ -105,7 +105,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Flexible:
\code{\link{create_bar_asis}()},
@ -121,7 +150,8 @@ Other Flexible:
\code{\link{create_sankey}()},
\code{\link{create_scatter}()},
\code{\link{create_stacked}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Flexible}
\concept{Visualization}

34
man/create_bubble.Rd
Просмотреть файл

@ -102,7 +102,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Flexible:
\code{\link{create_bar_asis}()},
@ -118,7 +147,8 @@ Other Flexible:
\code{\link{create_sankey}()},
\code{\link{create_scatter}()},
\code{\link{create_stacked}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Flexible}
\concept{Visualization}

34
man/create_dist.Rd
Просмотреть файл

@ -102,7 +102,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Flexible:
\code{\link{create_bar_asis}()},
@ -118,7 +147,8 @@ Other Flexible:
\code{\link{create_sankey}()},
\code{\link{create_scatter}()},
\code{\link{create_stacked}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Flexible}
\concept{Visualization}

7
man/create_dt.Rd
Просмотреть файл

@ -15,13 +15,16 @@ create_dt(x, rounding = 1, freeze = 2)
which includes the row number column.}
}
\description{
See https://martinctc.github.io/blog/vignette-downloadable-tables-in-rmarkdown-with-the-dt-package/ for more.
See
\url{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}()},
\code{\link{import_to_fst}()},
\code{\link{import_wpa}()}
\code{\link{import_wpa}()},
\code{\link{standardise_pq}()}
}
\concept{Import and Export}

34
man/create_fizz.Rd
Просмотреть файл

@ -92,7 +92,36 @@ Other Visualization:
\code{\link{external_network_plot}()},
\code{\link{hr_trend}()},
\code{\link{hrvar_count}()},
\code{\link{internal_network_plot}()}
\code{\link{internal_network_plot}()},
\code{\link{keymetrics_scan}()},
\code{\link{meeting_dist}()},
\code{\link{meeting_fizz}()},
\code{\link{meeting_line}()},
\code{\link{meeting_quality}()},
\code{\link{meeting_rank}()},
\code{\link{meeting_summary}()},
\code{\link{meeting_trend}()},
\code{\link{meetingtype_dist_ca}()},
\code{\link{meetingtype_dist_mt}()},
\code{\link{meetingtype_dist}()},
\code{\link{meetingtype_summary}()},
\code{\link{mgrcoatt_dist}()},
\code{\link{mgrrel_matrix}()},
\code{\link{one2one_dist}()},
\code{\link{one2one_fizz}()},
\code{\link{one2one_line}()},
\code{\link{one2one_rank}()},
\code{\link{one2one_sum}()},
\code{\link{one2one_trend}()},
\code{\link{period_change}()},
\code{\link{workloads_dist}()},
\code{\link{workloads_fizz}()},
\code{\link{workloads_line}()},
\code{\link{workloads_rank}()},
\code{\link{workloads_summary}()},
\code{\link{workloads_trend}()},
\code{\link{workpatterns_area}()},
\code{\link{workpatterns_rank}()}
Other Flexible:
\code{\link{create_bar_asis}()},
@ -108,7 +137,8 @@ Other Flexible:
\code{\link{create_sankey}()},
\code{\link{create_scatter}()},
\code{\link{create_stacked}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Flexible}
\concept{Visualization}

3
man/create_hist.Rd
Просмотреть файл

@ -84,6 +84,7 @@ Other Flexible:
\code{\link{create_sankey}()},
\code{\link{create_scatter}()},
\code{\link{create_stacked}()},
\code{\link{create_trend}()}
\code{\link{create_trend}()},
\code{\link{period_change}()}
}
\concept{Flexible}

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше