docs: clarify create_dist units (#77)

R/create_dist.R

@@ -13,8 +13,11 @@
 #' @param data A Standard Person Query dataset in the form of a data frame.
 #' @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 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:
 #'   - `"plot"`
@@ -26,7 +29,8 @@
 #' e.g. c(10, 15, 20)
 #' @param dist_colours A character vector of length four to specify colour
 #' codes for the stacked bars.
-#' @param unit See `cut_hour()`.
+#' @param unit String to specify what units. This defaults to `"hours"` but can
+#'   accept any custom string. See `cut_hour()` for more details.
 #'
 #' @return
 #' A different output is returned depending on the value passed to the `return` argument:

man/afterhours_dist.Rd

@@ -15,9 +15,12 @@ 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}{HR Variable by which to split metrics. Accepts a character
+vector, defaults to "Organization" but accepts any character vector, e.g.
+"LevelDesignation"}
 
-\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{return}{String specifying what to return. This must be one of the following strings:
 \itemize{

man/collaboration_dist.Rd

@@ -33,9 +33,12 @@ collaboration_distribution(
 \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}{HR Variable by which to split metrics. Accepts a character
+vector, defaults to "Organization" but accepts any character vector, e.g.
+"LevelDesignation"}
 
-\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{return}{String specifying what to return. This must be one of the following strings:
 \itemize{

man/create_dist.Rd

@@ -21,9 +21,12 @@ 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}{HR Variable by which to split metrics. Accepts a character
+vector, defaults to "Organization" but accepts any character vector, e.g.
+"LevelDesignation"}
 
-\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{return}{String specifying what to return. This must be one of the following strings:
 \itemize{
@@ -39,7 +42,8 @@ e.g. c(10, 15, 20)}
 \item{dist_colours}{A character vector of length four to specify colour
 codes for the stacked bars.}
 
-\item{unit}{See \code{cut_hour()}.}
+\item{unit}{String to specify what units. This defaults to \code{"hours"} but can
+accept any custom string. See \code{cut_hour()} for more details.}
 }
 \value{
 A different output is returned depending on the value passed to the \code{return} argument:

man/email_dist.Rd

@@ -15,9 +15,12 @@ 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}{HR Variable by which to split metrics. Accepts a character
+vector, defaults to "Organization" but accepts any character vector, e.g.
+"LevelDesignation"}
 
-\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{return}{String specifying what to return. This must be one of the following strings:
 \itemize{

man/meeting_dist.Rd

@@ -15,9 +15,12 @@ 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}{HR Variable by which to split metrics. Accepts a character
+vector, defaults to "Organization" but accepts any character vector, e.g.
+"LevelDesignation"}
 
-\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{return}{String specifying what to return. This must be one of the following strings:
 \itemize{

man/one2one_dist.Rd

@@ -15,9 +15,12 @@ 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}{HR Variable by which to split metrics. Accepts a character
+vector, defaults to "Organization" but accepts any character vector, e.g.
+"LevelDesignation"}
 
-\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{return}{String specifying what to return. This must be one of the following strings:
 \itemize{

man/workloads_dist.Rd

@@ -15,9 +15,12 @@ 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}{HR Variable by which to split metrics. Accepts a character
+vector, defaults to "Organization" but accepts any character vector, e.g.
+"LevelDesignation"}
 
-\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{return}{String specifying what to return. This must be one of the following strings:
 \itemize{