From 83648b40ff76fb42f4859b9db58f1e00475929dd Mon Sep 17 00:00:00 2001 From: Martin Chan Date: Thu, 18 Mar 2021 14:17:46 +0000 Subject: [PATCH] docs: use template spq-params --- R/create_dist.R | 10 +++------- man/afterhours_dist.Rd | 11 ++++++----- man/collaboration_dist.Rd | 11 ++++++----- man/create_dist.Rd | 11 ++++++----- man/email_dist.Rd | 11 ++++++----- man/meeting_dist.Rd | 11 ++++++----- man/one2one_dist.Rd | 11 ++++++----- man/workloads_dist.Rd | 11 ++++++----- 8 files changed, 45 insertions(+), 42 deletions(-) diff --git a/R/create_dist.R b/R/create_dist.R index 476b6a31..beb20485 100644 --- a/R/create_dist.R +++ b/R/create_dist.R @@ -10,16 +10,12 @@ #' Returns a stacked bar plot by default. #' Additional options available to return a table with distribution elements. #' -#' @param data A Standard Person Query dataset in the form of a data frame. +#' @template spq-params #' @param metric String containing the name of the metric, #' e.g. "Collaboration_hours" -#' @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 String specifying what to return. This must be one of the following strings: +#' @param return String specifying what to return. This must be one of the +#' following strings: #' - `"plot"` #' - `"table"` #' diff --git a/man/afterhours_dist.Rd b/man/afterhours_dist.Rd index b8c9bc4f..4cba8955 100644 --- a/man/afterhours_dist.Rd +++ b/man/afterhours_dist.Rd @@ -15,14 +15,15 @@ afterhours_dist( \arguments{ \item{data}{A Standard Person Query dataset in the form of a data frame.} -\item{hrvar}{HR Variable by which to split metrics. Accepts a character -vector, 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.} +size. Defaults to 5.} -\item{return}{String specifying what to return. This must be one of the following strings: +\item{return}{String specifying what to return. This must be one of the +following strings: \itemize{ \item \code{"plot"} \item \code{"table"} diff --git a/man/collaboration_dist.Rd b/man/collaboration_dist.Rd index 9feee6b6..2940a6bf 100644 --- a/man/collaboration_dist.Rd +++ b/man/collaboration_dist.Rd @@ -24,14 +24,15 @@ collab_dist( \arguments{ \item{data}{A Standard Person Query dataset in the form of a data frame.} -\item{hrvar}{HR Variable by which to split metrics. Accepts a character -vector, 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.} +size. Defaults to 5.} -\item{return}{String specifying what to return. This must be one of the following strings: +\item{return}{String specifying what to return. This must be one of the +following strings: \itemize{ \item \code{"plot"} \item \code{"table"} diff --git a/man/create_dist.Rd b/man/create_dist.Rd index 17949b74..fb518ee4 100644 --- a/man/create_dist.Rd +++ b/man/create_dist.Rd @@ -21,14 +21,15 @@ create_dist( \item{metric}{String containing the name of the metric, e.g. "Collaboration_hours"} -\item{hrvar}{HR Variable by which to split metrics. Accepts a character -vector, 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.} +size. Defaults to 5.} -\item{return}{String specifying what to return. This must be one of the following strings: +\item{return}{String specifying what to return. This must be one of the +following strings: \itemize{ \item \code{"plot"} \item \code{"table"} diff --git a/man/email_dist.Rd b/man/email_dist.Rd index 62bd6a6b..13912e06 100644 --- a/man/email_dist.Rd +++ b/man/email_dist.Rd @@ -15,14 +15,15 @@ email_dist( \arguments{ \item{data}{A Standard Person Query dataset in the form of a data frame.} -\item{hrvar}{HR Variable by which to split metrics. Accepts a character -vector, 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.} +size. Defaults to 5.} -\item{return}{String specifying what to return. This must be one of the following strings: +\item{return}{String specifying what to return. This must be one of the +following strings: \itemize{ \item \code{"plot"} \item \code{"table"} diff --git a/man/meeting_dist.Rd b/man/meeting_dist.Rd index adf75123..c73b1bd2 100644 --- a/man/meeting_dist.Rd +++ b/man/meeting_dist.Rd @@ -15,14 +15,15 @@ meeting_dist( \arguments{ \item{data}{A Standard Person Query dataset in the form of a data frame.} -\item{hrvar}{HR Variable by which to split metrics. Accepts a character -vector, 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.} +size. Defaults to 5.} -\item{return}{String specifying what to return. This must be one of the following strings: +\item{return}{String specifying what to return. This must be one of the +following strings: \itemize{ \item \code{"plot"} \item \code{"table"} diff --git a/man/one2one_dist.Rd b/man/one2one_dist.Rd index ab64607a..15194c79 100644 --- a/man/one2one_dist.Rd +++ b/man/one2one_dist.Rd @@ -15,14 +15,15 @@ one2one_dist( \arguments{ \item{data}{A Standard Person Query dataset in the form of a data frame.} -\item{hrvar}{HR Variable by which to split metrics. Accepts a character -vector, 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.} +size. Defaults to 5.} -\item{return}{String specifying what to return. This must be one of the following strings: +\item{return}{String specifying what to return. This must be one of the +following strings: \itemize{ \item \code{"plot"} \item \code{"table"} diff --git a/man/workloads_dist.Rd b/man/workloads_dist.Rd index c0f582b6..02bdeeae 100644 --- a/man/workloads_dist.Rd +++ b/man/workloads_dist.Rd @@ -15,14 +15,15 @@ workloads_dist( \arguments{ \item{data}{A Standard Person Query dataset in the form of a data frame.} -\item{hrvar}{HR Variable by which to split metrics. Accepts a character -vector, 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.} +size. Defaults to 5.} -\item{return}{String specifying what to return. This must be one of the following strings: +\item{return}{String specifying what to return. This must be one of the +following strings: \itemize{ \item \code{"plot"} \item \code{"table"}