зеркало из https://github.com/microsoft/wpa.git
docs: add alias and clean documentation
Changes mainly to _dist and _sum functions
This commit is contained in:
Родитель
7e6e70290f
Коммит
e42baba7d3
|
@ -50,6 +50,7 @@ export(email_dist)
|
|||
export(email_fizz)
|
||||
export(email_line)
|
||||
export(email_rank)
|
||||
export(email_sum)
|
||||
export(email_summary)
|
||||
export(email_trend)
|
||||
export(export)
|
||||
|
@ -79,18 +80,19 @@ export(internal_network_plot)
|
|||
export(is_date_format)
|
||||
export(keymetrics_scan)
|
||||
export(meeting_dist)
|
||||
export(meeting_distribution)
|
||||
export(meeting_fizz)
|
||||
export(meeting_line)
|
||||
export(meeting_quality)
|
||||
export(meeting_rank)
|
||||
export(meeting_skim)
|
||||
export(meeting_sum)
|
||||
export(meeting_summary)
|
||||
export(meeting_tm_report)
|
||||
export(meeting_trend)
|
||||
export(meetingtype_dist)
|
||||
export(meetingtype_dist_ca)
|
||||
export(meetingtype_dist_mt)
|
||||
export(meetingtype_sum)
|
||||
export(meetingtype_summary)
|
||||
export(mgrcoatt_dist)
|
||||
export(mgrrel_matrix)
|
||||
|
@ -99,6 +101,7 @@ export(one2one_fizz)
|
|||
export(one2one_line)
|
||||
export(one2one_rank)
|
||||
export(one2one_sum)
|
||||
export(one2one_summary)
|
||||
export(one2one_trend)
|
||||
export(period_change)
|
||||
export(personas_hclust)
|
||||
|
@ -124,6 +127,7 @@ export(workloads_dist)
|
|||
export(workloads_fizz)
|
||||
export(workloads_line)
|
||||
export(workloads_rank)
|
||||
export(workloads_sum)
|
||||
export(workloads_summary)
|
||||
export(workloads_trend)
|
||||
export(workpatterns_area)
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
|
||||
# --------------------------------------------------------------------------------------------
|
||||
|
||||
#' @title After-Hours distribution
|
||||
#' @title Distribution of After-hours Collaboration Hours as a 100% stacked bar
|
||||
#' @name afterhours_dist
|
||||
#'
|
||||
#' @description Analyse the distribution of weekly after-hours collaboration time.
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
|
||||
# --------------------------------------------------------------------------------------------
|
||||
|
||||
#' @title Collaboration Hours distribution
|
||||
#' @title Distribution of Collaboration Hours as a 100% stacked bar
|
||||
#'
|
||||
#' @description
|
||||
#' Analyze the distribution of Collaboration Hours.
|
||||
|
@ -39,7 +39,3 @@ collaboration_dist <- function(data,
|
|||
|
||||
|
||||
}
|
||||
|
||||
#' @rdname collaboration_dist
|
||||
#' @export
|
||||
collaboration_distribution <- collaboration_dist
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
|
||||
# --------------------------------------------------------------------------------------------
|
||||
|
||||
#' @title Email Hours distribution
|
||||
#' @title Distribution of Email Hours as a 100% stacked bar
|
||||
#'
|
||||
#' @description
|
||||
#' Analyze Email Hours distribution.
|
||||
|
|
|
@ -41,7 +41,9 @@ email_summary <- function(data,
|
|||
|
||||
}
|
||||
|
||||
|
||||
#' @rdname email_summary
|
||||
#' @export
|
||||
email_sum <- email_summary
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
|
||||
# --------------------------------------------------------------------------------------------
|
||||
|
||||
#' @title Meeting Hours distribution
|
||||
#' @title Distribution of Meeting Hours as a 100% stacked bar
|
||||
#'
|
||||
#' @description
|
||||
#' Analyze Meeting Hours distribution.
|
||||
|
@ -40,7 +40,3 @@ meeting_dist <- function(data,
|
|||
return = return,
|
||||
cut = cut)
|
||||
}
|
||||
|
||||
#' @rdname meeting_dist
|
||||
#' @export
|
||||
meeting_distribution <- meeting_dist
|
||||
|
|
|
@ -38,6 +38,9 @@ meeting_summary <- function(data,
|
|||
bar_colour = "default")
|
||||
}
|
||||
|
||||
#' @rdname meeting_summary
|
||||
#' @export
|
||||
meeting_sum <- meeting_summary
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
#' @title Meeting Type Distribution
|
||||
#' @title Distribution of Meeting Types by number of Attendees and Duration
|
||||
#'
|
||||
#' @description
|
||||
#' Calculate the hour distribution of internal meeting types.
|
||||
|
|
|
@ -21,6 +21,8 @@
|
|||
#' @import ggplot2
|
||||
#' @import dplyr
|
||||
#'
|
||||
#' @family Meetings
|
||||
#'
|
||||
#' @export
|
||||
meetingtype_summary <- function(data,
|
||||
hrvar = "Organization",
|
||||
|
@ -67,3 +69,8 @@ meetingtype_summary <- function(data,
|
|||
stop("Please enter a valid input for `return`.")
|
||||
}
|
||||
}
|
||||
|
||||
#' @rdname meetingtype_summary
|
||||
#' @export
|
||||
meetingtype_sum <- meetingtype_summary
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
|
||||
# --------------------------------------------------------------------------------------------
|
||||
|
||||
#' @title Manager 1:1 Time Trend distribution
|
||||
#' @title Distribution of Manager 1:1 Time as a 100% stacked bar
|
||||
#'
|
||||
#' @description
|
||||
#' Analyze Manager 1:1 Time distribution.
|
||||
|
|
|
@ -39,7 +39,9 @@ one2one_sum <- function(data,
|
|||
|
||||
}
|
||||
|
||||
|
||||
#' @rdname one2one_sum
|
||||
#' @export
|
||||
one2one_summary <- one2one_sum
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
# Licensed under the MIT License. See LICENSE.txt in the project root for license information.
|
||||
# --------------------------------------------------------------------------------------------
|
||||
|
||||
#' @title Distribution of Work Week Span
|
||||
#' @title Distribution of Work Week Span as a 100% stacked bar
|
||||
#'
|
||||
#' @description
|
||||
#' Analyze Work Week Span distribution.
|
||||
|
|
|
@ -38,3 +38,7 @@ workloads_summary <- function(data,
|
|||
bar_colour = "darkblue")
|
||||
}
|
||||
|
||||
|
||||
#' @rdname workloads_summary
|
||||
#' @export
|
||||
workloads_sum <- workloads_summary
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
% Please edit documentation in R/afterhours_dist.R
|
||||
\name{afterhours_dist}
|
||||
\alias{afterhours_dist}
|
||||
\title{After-Hours distribution}
|
||||
\title{Distribution of After-hours Collaboration Hours as a 100\% stacked bar}
|
||||
\usage{
|
||||
afterhours_dist(
|
||||
data,
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
\name{collaboration_dist}
|
||||
\alias{collaboration_dist}
|
||||
\alias{collaboration_distribution}
|
||||
\title{Collaboration Hours distribution}
|
||||
\title{Distribution of Collaboration Hours as a 100\% stacked bar}
|
||||
\usage{
|
||||
collaboration_dist(
|
||||
data,
|
||||
|
@ -13,14 +13,6 @@ collaboration_dist(
|
|||
cut = c(15, 20, 25)
|
||||
)
|
||||
|
||||
collaboration_distribution(
|
||||
data,
|
||||
hrvar = "Organization",
|
||||
mingroup = 5,
|
||||
return = "plot",
|
||||
cut = c(15, 20, 25)
|
||||
)
|
||||
|
||||
collaboration_distribution(
|
||||
data,
|
||||
hrvar = "Organization",
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
% Please edit documentation in R/email_dist.R
|
||||
\name{email_dist}
|
||||
\alias{email_dist}
|
||||
\title{Email Hours distribution}
|
||||
\title{Distribution of Email Hours as a 100\% stacked bar}
|
||||
\usage{
|
||||
email_dist(
|
||||
data,
|
||||
|
|
|
@ -2,9 +2,12 @@
|
|||
% Please edit documentation in R/email_summary.R
|
||||
\name{email_summary}
|
||||
\alias{email_summary}
|
||||
\alias{email_sum}
|
||||
\title{Email Summary}
|
||||
\usage{
|
||||
email_summary(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
|
||||
email_sum(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
}
|
||||
\arguments{
|
||||
\item{data}{A Standard Person Query dataset in the form of a data frame.}
|
||||
|
|
|
@ -2,14 +2,7 @@
|
|||
% Please edit documentation in R/identify_outlier.R
|
||||
\name{identify_outlier}
|
||||
\alias{identify_outlier}
|
||||
\title{Identify outliers across time
|
||||
|
||||
This function takes in a selected metric and uses
|
||||
z-score (number of standard deviations) to identify outliers
|
||||
across time. There are applications in this for identifying
|
||||
weeks with abnormally low collaboration activity, e.g. holidays.
|
||||
Time as a grouping variable can be overridden with the \code{group_var}
|
||||
argument.}
|
||||
\title{Identify metric outliers over a date interval}
|
||||
\usage{
|
||||
identify_outlier(data, group_var = "Date", metric = "Collaboration_hours")
|
||||
}
|
||||
|
@ -27,8 +20,6 @@ Returns a data frame with \code{Date} (if grouping variable is not set),
|
|||
the metric, and the corresponding z-score.
|
||||
}
|
||||
\description{
|
||||
Identify outliers across time
|
||||
|
||||
This function takes in a selected metric and uses
|
||||
z-score (number of standard deviations) to identify outliers
|
||||
across time. There are applications in this for identifying
|
||||
|
|
|
@ -2,8 +2,7 @@
|
|||
% Please edit documentation in R/meeting_dist.R
|
||||
\name{meeting_dist}
|
||||
\alias{meeting_dist}
|
||||
\alias{meeting_distribution}
|
||||
\title{Meeting Hours distribution}
|
||||
\title{Distribution of Meeting Hours as a 100\% stacked bar}
|
||||
\usage{
|
||||
meeting_dist(
|
||||
data,
|
||||
|
@ -12,14 +11,6 @@ meeting_dist(
|
|||
return = "plot",
|
||||
cut = c(5, 10, 15)
|
||||
)
|
||||
|
||||
meeting_distribution(
|
||||
data,
|
||||
hrvar = "Organization",
|
||||
mingroup = 5,
|
||||
return = "plot",
|
||||
cut = c(5, 10, 15)
|
||||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{data}{A Standard Person Query dataset in the form of a data frame.}
|
||||
|
|
|
@ -28,6 +28,7 @@ meeting_fizz(sq_data, hrvar = "Organization", return = "table")
|
|||
Other Meetings:
|
||||
\code{\link{meeting_line}()},
|
||||
\code{\link{meeting_rank}()},
|
||||
\code{\link{meeting_summary}()}
|
||||
\code{\link{meeting_summary}()},
|
||||
\code{\link{meetingtype_summary}()}
|
||||
}
|
||||
\concept{Meetings}
|
||||
|
|
|
@ -41,6 +41,7 @@ meeting_line(sq_data, hrvar = "LevelDesignation", return = "table")
|
|||
Other Meetings:
|
||||
\code{\link{meeting_fizz}()},
|
||||
\code{\link{meeting_rank}()},
|
||||
\code{\link{meeting_summary}()}
|
||||
\code{\link{meeting_summary}()},
|
||||
\code{\link{meetingtype_summary}()}
|
||||
}
|
||||
\concept{Meetings}
|
||||
|
|
|
@ -34,6 +34,7 @@ See \code{create_rank()} for applying the same analysis to a different metric.
|
|||
Other Meetings:
|
||||
\code{\link{meeting_fizz}()},
|
||||
\code{\link{meeting_line}()},
|
||||
\code{\link{meeting_summary}()}
|
||||
\code{\link{meeting_summary}()},
|
||||
\code{\link{meetingtype_summary}()}
|
||||
}
|
||||
\concept{Meetings}
|
||||
|
|
|
@ -2,9 +2,12 @@
|
|||
% Please edit documentation in R/meeting_summary.R
|
||||
\name{meeting_summary}
|
||||
\alias{meeting_summary}
|
||||
\alias{meeting_sum}
|
||||
\title{Meeting Summary}
|
||||
\usage{
|
||||
meeting_summary(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
|
||||
meeting_sum(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
}
|
||||
\arguments{
|
||||
\item{data}{A Standard Person Query dataset in the form of a data frame.}
|
||||
|
@ -37,6 +40,7 @@ meeting_summary(sq_data, hrvar = "LevelDesignation", return = "table")
|
|||
Other Meetings:
|
||||
\code{\link{meeting_fizz}()},
|
||||
\code{\link{meeting_line}()},
|
||||
\code{\link{meeting_rank}()}
|
||||
\code{\link{meeting_rank}()},
|
||||
\code{\link{meetingtype_summary}()}
|
||||
}
|
||||
\concept{Meetings}
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
% Please edit documentation in R/meetingtype_dist.R
|
||||
\name{meetingtype_dist}
|
||||
\alias{meetingtype_dist}
|
||||
\title{Meeting Type Distribution}
|
||||
\title{Distribution of Meeting Types by number of Attendees and Duration}
|
||||
\usage{
|
||||
meetingtype_dist(data, hrvar = NULL, mingroup = 5, return = "plot")
|
||||
}
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
% Please edit documentation in R/meetingtype_summary.R
|
||||
\name{meetingtype_summary}
|
||||
\alias{meetingtype_summary}
|
||||
\alias{meetingtype_sum}
|
||||
\title{Create a summary bar chart of the proportion of Meeting Hours spent in Long or Large Meetings}
|
||||
\usage{
|
||||
meetingtype_summary(
|
||||
|
@ -10,6 +11,8 @@ meetingtype_summary(
|
|||
mingroup = 5,
|
||||
return = "plot"
|
||||
)
|
||||
|
||||
meetingtype_sum(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
}
|
||||
\arguments{
|
||||
\item{data}{Collaboration Assessment query in the form of a data frame. Requires the following variables:
|
||||
|
@ -35,3 +38,11 @@ Valid inputs are "plot" and "table".}
|
|||
This function creates a bar chart showing the percentage of meeting hours which are spent in
|
||||
long or large meetings.
|
||||
}
|
||||
\seealso{
|
||||
Other Meetings:
|
||||
\code{\link{meeting_fizz}()},
|
||||
\code{\link{meeting_line}()},
|
||||
\code{\link{meeting_rank}()},
|
||||
\code{\link{meeting_summary}()}
|
||||
}
|
||||
\concept{Meetings}
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
% Please edit documentation in R/one2one_dist.R
|
||||
\name{one2one_dist}
|
||||
\alias{one2one_dist}
|
||||
\title{Manager 1:1 Time Trend distribution}
|
||||
\title{Distribution of Manager 1:1 Time as a 100\% stacked bar}
|
||||
\usage{
|
||||
one2one_dist(
|
||||
data,
|
||||
|
|
|
@ -2,9 +2,12 @@
|
|||
% Please edit documentation in R/one2one_sum.R
|
||||
\name{one2one_sum}
|
||||
\alias{one2one_sum}
|
||||
\alias{one2one_summary}
|
||||
\title{Manager 1:1 Time Summary}
|
||||
\usage{
|
||||
one2one_sum(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
|
||||
one2one_summary(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
}
|
||||
\arguments{
|
||||
\item{data}{A Standard Person Query dataset in the form of a data frame.}
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
% Please edit documentation in R/workloads_dist.R
|
||||
\name{workloads_dist}
|
||||
\alias{workloads_dist}
|
||||
\title{Distribution of Work Week Span}
|
||||
\title{Distribution of Work Week Span as a 100\% stacked bar}
|
||||
\usage{
|
||||
workloads_dist(
|
||||
data,
|
||||
|
|
|
@ -2,9 +2,12 @@
|
|||
% Please edit documentation in R/workloads_summary.R
|
||||
\name{workloads_summary}
|
||||
\alias{workloads_summary}
|
||||
\alias{workloads_sum}
|
||||
\title{Work Week Span Summary}
|
||||
\usage{
|
||||
workloads_summary(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
|
||||
workloads_sum(data, hrvar = "Organization", mingroup = 5, return = "plot")
|
||||
}
|
||||
\arguments{
|
||||
\item{data}{A Standard Person Query dataset in the form of a data frame.}
|
||||
|
|
Загрузка…
Ссылка в новой задаче