docs: return options (#31)

R/afterhours_summary.R

@@ -24,6 +24,7 @@
 #'
 #' # Return a summary table
 #' afterhours_summary(sq_data, hrvar = "LevelDesignation", return = "table")
+#'
 #' @export
 afterhours_summary <- function(data,
                               hrvar = "Organization",

R/email_summary.R

@@ -11,20 +11,17 @@
 #' Additional options available to return a summary table.
 #'
 #' @inheritParams create_bar
-#'
+#' @inherit create_bar return
 #'
 #' @family Emails
 #'
-#' @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
 #' email_summary(sq_data, hrvar = "LevelDesignation")
 #'
 #' # Return a summary table
 #' email_summary(sq_data, hrvar = "LevelDesignation", return = "table")
+#'
 #' @export
 
 email_summary <- function(data,

R/meeting_summary.R

@@ -11,19 +11,17 @@
 #' Additional options available to return a summary table.
 #'
 #' @inheritParams create_bar
+#' @inherit create_bar return
 #'
 #' @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.
-#'
 #' @examples
 #' # Return a ggplot bar chart
 #' meeting_summary(sq_data, hrvar = "LevelDesignation")
 #'
 #' # Return a summary table
 #' meeting_summary(sq_data, hrvar = "LevelDesignation", return = "table")
+#'
 #' @export
 meeting_summary <- function(data,
                               hrvar = "Organization",

R/one2one_sum.R

@@ -11,12 +11,16 @@
 #' Additional options available to return a summary table.
 #'
 #' @inheritParams create_bar
+#' @inherit create_bar return
 #'
 #' @family Managerial Relations
 #'
-#' @return
+#' @examples
-#' Returns a ggplot object by default, where 'plot' is passed in `return`.
+#' # Return a ggplot bar chart
-#' When 'table' is passed, a summary table is returned as a data frame.
+#' one2one_sum(sq_data, hrvar = "LevelDesignation")
+#'
+#' # Return a summary table
+#' one2one_sum(sq_data, hrvar = "LevelDesignation", return = "table")
 #'
 #' @export
 

man/afterhours_summary.Rd

@@ -46,6 +46,7 @@ afterhours_summary(sq_data, hrvar = "LevelDesignation")
 
 # Return a summary table
 afterhours_summary(sq_data, hrvar = "LevelDesignation", return = "table")
+
 }
 \seealso{
 Other After-Hours: 

man/email_summary.Rd

@@ -26,8 +26,11 @@ but accepts any character vector, e.g. "LevelDesignation"}
 See \code{Value} for more information.}
 }
 \value{
-Returns a ggplot object by default, where 'plot' is passed in \code{return}.
+A different output is returned depending on the value passed to the \code{return} argument:
-When 'table' is passed, a summary table is returned as a data frame.
+\itemize{
+\item \code{"plot"}: ggplot object. A bar plot for the metric.
+\item \code{"table"}: data frame. A summary table for the metric.
+}
 }
 \description{
 Provides an overview analysis of weekly email hours.
@@ -40,6 +43,7 @@ email_summary(sq_data, hrvar = "LevelDesignation")
 
 # Return a summary table
 email_summary(sq_data, hrvar = "LevelDesignation", return = "table")
+
 }
 \seealso{
 Other Emails: 

man/meeting_summary.Rd

@@ -26,8 +26,11 @@ but accepts any character vector, e.g. "LevelDesignation"}
 See \code{Value} for more information.}
 }
 \value{
-Returns a ggplot object by default, where 'plot' is passed in \code{return}.
+A different output is returned depending on the value passed to the \code{return} argument:
-When 'table' is passed, a summary table is returned as a data frame.
+\itemize{
+\item \code{"plot"}: ggplot object. A bar plot for the metric.
+\item \code{"table"}: data frame. A summary table for the metric.
+}
 }
 \description{
 Provides an overview analysis of weekly meeting hours.
@@ -40,6 +43,7 @@ meeting_summary(sq_data, hrvar = "LevelDesignation")
 
 # Return a summary table
 meeting_summary(sq_data, hrvar = "LevelDesignation", return = "table")
+
 }
 \seealso{
 Other Meetings: 

man/one2one_sum.Rd

@@ -26,13 +26,24 @@ but accepts any character vector, e.g. "LevelDesignation"}
 See \code{Value} for more information.}
 }
 \value{
-Returns a ggplot object by default, where 'plot' is passed in \code{return}.
+A different output is returned depending on the value passed to the \code{return} argument:
-When 'table' is passed, a summary table is returned as a data frame.
+\itemize{
+\item \code{"plot"}: ggplot object. A bar plot for the metric.
+\item \code{"table"}: data frame. A summary table for the metric.
+}
 }
 \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.
+}
+\examples{
+# Return a ggplot bar chart
+one2one_sum(sq_data, hrvar = "LevelDesignation")
+
+# Return a summary table
+one2one_sum(sq_data, hrvar = "LevelDesignation", return = "table")
+
 }
 \seealso{
 Other Managerial Relations: