docs: make consistent return options (#31)

R/workloads_dist.R

@@ -11,11 +11,17 @@
 #' Additional options available to return a table with distribution elements.
 #'
 #' @inheritParams create_dist
+#' @inherit create_dist return
 #'
 #' @family Workloads
 #'
 #' @examples
+#' ## Return a plot
+#' workloads_dist(sq_data, hrvar = "Organization", return = "plot")
+#'
+#' ## Return a summary table
 #' workloads_dist(sq_data, hrvar = "Organization", return = "table")
+#'
 #' @export
 
 workloads_dist <- function(data,

R/workloads_fizz.R

@@ -11,11 +11,17 @@
 #' Additional options available to return a table with distribution elements.
 #'
 #' @inheritParams create_fizz
+#' @inherit create_fizz return
 #'
 #' @family Workloads
 #'
 #' @examples
-#' meeting_fizz(sq_data, hrvar = "Organization", return = "table")
+#' # Return a plot
+#' workloads_fizz(sq_data, hrvar = "Organization", return = "plot")
+#'
+#' # Return a table
+#' workloads_fizz(sq_data, hrvar = "Organization", return = "table")
+#'
 #' @export
 
 workloads_fizz <- function(data,

man/workloads_dist.Rd

@@ -30,13 +30,25 @@ See \code{Value} for more information.}
 \item{cut}{A numeric vector of length three to specify the breaks for the distribution,
 e.g. c(10, 15, 20)}
 }
+\value{
+A different output is returned depending on the value passed to the \code{return} argument:
+\itemize{
+\item \code{"plot"}: ggplot object. A stacked bar plot for the metric.
+\item \code{"table"}: data frame. A summary table for the metric.
+}
+}
 \description{
 Analyze Work Week Span distribution.
 Returns a stacked bar plot by default.
 Additional options available to return a table with distribution elements.
 }
 \examples{
+## Return a plot
+workloads_dist(sq_data, hrvar = "Organization", return = "plot")
+
+## Return a summary table
 workloads_dist(sq_data, hrvar = "Organization", return = "table")
+
 }
 \seealso{
 Other Workloads: 

man/workloads_fizz.Rd

@@ -21,13 +21,25 @@ workloads_fizz(data, hrvar = "Organization", mingroup = 5, return = "plot")
 
 See \code{Value} for more information.}
 }
+\value{
+A different output is returned depending on the value passed to the \code{return} argument:
+\itemize{
+\item \code{"plot"}: ggplot object. A jittered scatter plot for the metric.
+\item \code{"table"}: data frame. A summary table for the metric.
+}
+}
 \description{
 Analyze Work Week Span distribution, and returns
 a 'fizzy' scatter plot by default.
 Additional options available to return a table with distribution elements.
 }
 \examples{
-meeting_fizz(sq_data, hrvar = "Organization", return = "table")
+# Return a plot
+workloads_fizz(sq_data, hrvar = "Organization", return = "plot")
+
+# Return a table
+workloads_fizz(sq_data, hrvar = "Organization", return = "table")
+
 }
 \seealso{
 Other Workloads: