From f933ba6a04ce62a09049914c0cef5cd38340d097 Mon Sep 17 00:00:00 2001 From: Martin Chan Date: Tue, 30 Mar 2021 17:40:16 +0100 Subject: [PATCH] docs: package names in single quotes --- R/afterhours_trend.R | 2 +- R/collaboration_area.R | 2 +- R/collaboration_sum.R | 2 +- R/collaboration_trend.R | 2 +- R/create_IV.R | 6 +++--- R/create_bar.R | 2 +- R/create_bar_asis.R | 2 +- R/create_boxplot.R | 2 +- R/create_bubble.R | 2 +- R/create_dist.R | 2 +- R/create_fizz.R | 2 +- R/create_hist.R | 2 +- R/create_line.R | 2 +- R/create_rank.R | 2 +- R/create_scatter.R | 2 +- R/create_stacked.R | 2 +- R/create_trend.R | 2 +- R/export.R | 16 ++++++++-------- R/flex_index.R | 2 +- R/hrvar_count.R | 2 +- R/network_g2g.R | 6 +++--- R/network_leiden.R | 2 +- R/network_louvain.R | 2 +- R/network_p2p.R | 4 ++-- R/personas_hclust.R | 4 ++-- man/afterhours_dist.Rd | 2 +- man/afterhours_fizz.Rd | 2 +- man/afterhours_line.Rd | 2 +- man/afterhours_summary.Rd | 2 +- man/afterhours_trend.Rd | 2 +- man/collaboration_area.Rd | 2 +- man/collaboration_dist.Rd | 2 +- man/collaboration_fizz.Rd | 2 +- man/collaboration_line.Rd | 2 +- man/collaboration_rank.Rd | 2 +- man/collaboration_sum.Rd | 2 +- man/collaboration_trend.Rd | 2 +- man/create_IV.Rd | 4 ++-- man/create_bar.Rd | 2 +- man/create_bar_asis.Rd | 2 +- man/create_boxplot.Rd | 2 +- man/create_bubble.Rd | 2 +- man/create_dist.Rd | 2 +- man/create_fizz.Rd | 2 +- man/create_hist.Rd | 2 +- man/create_line.Rd | 2 +- man/create_rank.Rd | 2 +- man/create_scatter.Rd | 2 +- man/create_stacked.Rd | 2 +- man/create_trend.Rd | 2 +- man/email_dist.Rd | 2 +- man/email_fizz.Rd | 2 +- man/email_line.Rd | 2 +- man/email_rank.Rd | 2 +- man/email_summary.Rd | 2 +- man/email_trend.Rd | 2 +- man/export.Rd | 14 +++++++------- man/flex_index.Rd | 2 +- man/hrvar_count.Rd | 2 +- man/meeting_dist.Rd | 2 +- man/meeting_line.Rd | 2 +- man/meeting_quality.Rd | 2 +- man/meeting_rank.Rd | 2 +- man/meeting_summary.Rd | 2 +- man/meeting_trend.Rd | 2 +- man/network_g2g.Rd | 4 ++-- man/network_leiden.Rd | 2 +- man/network_louvain.Rd | 2 +- man/network_p2p.Rd | 2 +- man/one2one_dist.Rd | 2 +- man/one2one_fizz.Rd | 2 +- man/one2one_line.Rd | 2 +- man/one2one_rank.Rd | 2 +- man/one2one_sum.Rd | 2 +- man/one2one_trend.Rd | 2 +- man/personas_hclust.Rd | 4 ++-- man/plot_WOE.Rd | 2 +- man/workloads_dist.Rd | 2 +- man/workloads_fizz.Rd | 2 +- man/workloads_line.Rd | 2 +- man/workloads_rank.Rd | 2 +- man/workloads_summary.Rd | 2 +- man/workloads_trend.Rd | 2 +- 83 files changed, 105 insertions(+), 105 deletions(-) diff --git a/R/afterhours_trend.R b/R/afterhours_trend.R index eb059bae..fe752811 100644 --- a/R/afterhours_trend.R +++ b/R/afterhours_trend.R @@ -26,7 +26,7 @@ #' afterhours_trend(sq_data, hrvar = "LevelDesignation", return = "table") #' #' @return -#' Returns a ggplot object by default, where 'plot' is passed in `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. #' #' @export diff --git a/R/collaboration_area.R b/R/collaboration_area.R index b4e21a11..8e8f0df9 100644 --- a/R/collaboration_area.R +++ b/R/collaboration_area.R @@ -49,7 +49,7 @@ #' #' @return #' A different output is returned depending on the value passed to the `return` argument: -#' - `"plot"`: ggplot object. A stacked area plot for the metric. +#' - `"plot"`: 'ggplot' object. A stacked area plot for the metric. #' - `"table"`: data frame. A summary table for the metric. #' #' @export diff --git a/R/collaboration_sum.R b/R/collaboration_sum.R index b3807456..7a8e226a 100644 --- a/R/collaboration_sum.R +++ b/R/collaboration_sum.R @@ -28,7 +28,7 @@ #' @family Collaboration #' #' @return -#' Returns a ggplot object by default, where 'plot' is passed in `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. #' #' @export diff --git a/R/collaboration_trend.R b/R/collaboration_trend.R index 057bcd13..a1ed7c1b 100644 --- a/R/collaboration_trend.R +++ b/R/collaboration_trend.R @@ -18,7 +18,7 @@ #' @family Collaboration #' #' @return -#' Returns a ggplot object by default, where 'plot' is passed in `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. #' #' @export diff --git a/R/create_IV.R b/R/create_IV.R index 31deedb6..b571986b 100644 --- a/R/create_IV.R +++ b/R/create_IV.R @@ -30,11 +30,11 @@ #' @return #' A different output is returned depending on the value passed to the `return` #' argument: -#' - `"plot"`: ggplot object. A bar plot showing the IV value of the top +#' - `"plot"`: 'ggplot' object. A bar plot showing the IV value of the top #' (maximum 12) variables. #' - `"summary"`: data frame. A summary table for the metric. #' - `"list"`: list. A list of outputs for all the input variables. -#' - `"plot-WOE"`: A list of ggplot objects that show the WOE for each +#' - `"plot-WOE"`: A list of 'ggplot' objects that show the WOE for each #' predictor used in the model. #' - `"IV"` returns the original Information object returned by #' `Information::create_infotables()`. @@ -198,7 +198,7 @@ create_IV <- function(data, #' @param predictor String with the name of the predictor variable. #' #' @return -#' ggplot object. Bar plot with 'WOE' as the y-axis and bins of the predictor +#' 'ggplot' object. Bar plot with 'WOE' as the y-axis and bins of the predictor #' variable as the horizontal axis. #' #' @family Support diff --git a/R/create_bar.R b/R/create_bar.R index 09c4fbf7..740c22a8 100644 --- a/R/create_bar.R +++ b/R/create_bar.R @@ -32,7 +32,7 @@ #' #' @return #' A different output is returned depending on the value passed to the `return` argument: -#' - `"plot"`: ggplot object. A bar plot for the metric. +#' - `"plot"`: 'ggplot' object. A bar plot for the metric. #' - `"table"`: data frame. A summary table for the metric. #' #' @import dplyr diff --git a/R/create_bar_asis.R b/R/create_bar_asis.R index d6dd53a4..ceca1744 100644 --- a/R/create_bar_asis.R +++ b/R/create_bar_asis.R @@ -30,7 +30,7 @@ #' labels #' #' @return -#' ggplot object. A horizontal bar plot. +#' 'ggplot' object. A horizontal bar plot. #' #' @examples #' # Creating a custom bar plot without mean aggregation diff --git a/R/create_boxplot.R b/R/create_boxplot.R index e17bcd43..b77cdd9f 100644 --- a/R/create_boxplot.R +++ b/R/create_boxplot.R @@ -26,7 +26,7 @@ #' #' @return #' A different output is returned depending on the value passed to the `return` argument: -#' - `"plot"`: ggplot object. A box plot for the metric. +#' - `"plot"`: 'ggplot' object. A box plot for the metric. #' - `"table"`: data frame. A summary table for the metric. #' #' @import dplyr diff --git a/R/create_bubble.R b/R/create_bubble.R index 185d0761..cb92a3e1 100644 --- a/R/create_bubble.R +++ b/R/create_bubble.R @@ -49,7 +49,7 @@ #' #' @return A different output is returned depending on the value passed to the #' `return` argument: -#' - `"plot"`: ggplot object. A bubble plot for the metric. +#' - `"plot"`: 'ggplot' object. A bubble plot for the metric. #' - `"table"`: data frame. A summary table for the metric. #' #' @export diff --git a/R/create_dist.R b/R/create_dist.R index beb20485..5ccac96d 100644 --- a/R/create_dist.R +++ b/R/create_dist.R @@ -31,7 +31,7 @@ #' #' @return #' A different output is returned depending on the value passed to the `return` argument: -#' - `"plot"`: ggplot object. A stacked bar plot for the metric. +#' - `"plot"`: 'ggplot' object. A stacked bar plot for the metric. #' - `"table"`: data frame. A summary table for the metric. #' #' @import dplyr diff --git a/R/create_fizz.R b/R/create_fizz.R index 601c9e0a..4a289ecb 100644 --- a/R/create_fizz.R +++ b/R/create_fizz.R @@ -24,7 +24,7 @@ #' #' @return #' A different output is returned depending on the value passed to the `return` argument: -#' - `"plot"`: ggplot object. A jittered scatter plot for the metric. +#' - `"plot"`: 'ggplot' object. A jittered scatter plot for the metric. #' - `"table"`: data frame. A summary table for the metric. #' #' @import dplyr diff --git a/R/create_hist.R b/R/create_hist.R index 14280cf1..e105e979 100644 --- a/R/create_hist.R +++ b/R/create_hist.R @@ -30,7 +30,7 @@ #' @return #' A different output is returned depending on the value passed to the `return` #' argument: -#' - `"plot"`: ggplot object. A faceted histogram for the metric. +#' - `"plot"`: 'ggplot' object. A faceted histogram for the metric. #' - `"table"`: data frame. A summary table for the metric. #' - `"data"`: data frame. Data with calculated person averages. #' - `"frequency`: list of data frames. Each data frame contains the diff --git a/R/create_line.R b/R/create_line.R index 1979f458..05acd090 100644 --- a/R/create_line.R +++ b/R/create_line.R @@ -46,7 +46,7 @@ #' #' @return #' A different output is returned depending on the value passed to the `return` argument: -#' - `"plot"`: ggplot object. A faceted line plot for the metric. +#' - `"plot"`: 'ggplot' object. A faceted line plot for the metric. #' - `"table"`: data frame. A summary table for the metric. #' #' @export diff --git a/R/create_rank.R b/R/create_rank.R index 82056a8d..bfd70a73 100644 --- a/R/create_rank.R +++ b/R/create_rank.R @@ -76,7 +76,7 @@ #' @return #' A different output is returned depending on the value passed to the `return` #' argument: -#' - `"plot"`: ggplot object. A bubble plot where the x-axis represents the +#' - `"plot"`: 'ggplot' object. A bubble plot where the x-axis represents the #' metric, the y-axis represents the HR attributes, and the size of the #' bubbles represent the size of the organizations. Note that there is no #' plot output if `mode` is set to `"combine"`. diff --git a/R/create_scatter.R b/R/create_scatter.R index fbff748b..95087fac 100644 --- a/R/create_scatter.R +++ b/R/create_scatter.R @@ -45,7 +45,7 @@ #' "Organization", mingroup = 100, return = "plot") #' #' @return -#' Returns a ggplot object by default, where 'plot' is passed in `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. #' #' @export diff --git a/R/create_stacked.R b/R/create_stacked.R index 86563f89..62cf01de 100644 --- a/R/create_stacked.R +++ b/R/create_stacked.R @@ -34,7 +34,7 @@ #' @family Flexible #' #' @return -#' Returns a ggplot object by default, where 'plot' is passed in `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 diff --git a/R/create_trend.R b/R/create_trend.R index 9099fd01..cfc0939c 100644 --- a/R/create_trend.R +++ b/R/create_trend.R @@ -30,7 +30,7 @@ #' create_trend(sq_data, metric = "Collaboration_hours", hrvar = "LevelDesignation") #' #' @return -#' Returns a ggplot object by default, where 'plot' is passed in `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. #' #' @export diff --git a/R/export.R b/R/export.R index acd2367c..437c4a00 100644 --- a/R/export.R +++ b/R/export.R @@ -8,15 +8,15 @@ #' @description #' A general use function to export {wpa} outputs to CSV, #' clipboard, or save as images. By default, `export()` copies -#' a data frame to the clipboard. If the input is a ggplot object, +#' a data frame to the clipboard. If the input is a 'ggplot' object, #' the default behaviour is to export a PNG. #' -#' @param x Data frame or ggplot object to be passed through. +#' @param x Data frame or 'ggplot' object to be passed through. #' @param method Character string specifying the method of export. #' Valid inputs include: #' - `"clipboard"` (default if input is data frame) #' - `"csv"` -#' - `"png"` (default if input is ggplot object) +#' - `"png"` (default if input is 'ggplot' object) #' - `"svg"` #' - `"jpeg"` #' - `"pdf"` @@ -32,10 +32,10 @@ #' argument: #' - `"clipboard"`: no return - data frame is saved to clipboard. #' - `"csv"`: CSV file containing data frame is saved to specified path. -#' - `"png"`: PNG file containing ggplot object is saved to specified path. -#' - `"svg"`: SVG file containing ggplot object is saved to specified path. -#' - `"jpeg"`: JPEG file containing ggplot object is saved to specified path. -#' - `"pdf"`: PDF file containing ggplot object is saved to specified path. +#' - `"png"`: PNG file containing 'ggplot' object is saved to specified path. +#' - `"svg"`: SVG file containing 'ggplot' object is saved to specified path. +#' - `"jpeg"`: JPEG file containing 'ggplot' object is saved to specified path. +#' - `"pdf"`: PDF file containing 'ggplot' object is saved to specified path. #' #' @importFrom utils write.csv #' @@ -60,7 +60,7 @@ export <- function(x, ## Force method to png if is.ggplot and method not appropriate if(is.ggplot(x) & method %in% c("clipboard", "csv")){ - message("Input is a ggplot object. Defaulted to exporting as PNG...") + message("Input is a 'ggplot' object. Defaulted to exporting as PNG...") method <- "png" } diff --git a/R/flex_index.R b/R/flex_index.R index b2b3c653..cd25bde3 100644 --- a/R/flex_index.R +++ b/R/flex_index.R @@ -77,7 +77,7 @@ #' @return #' A different output is returned depending on the value passed to the `return` #' argument: -#' - `"plot"`: ggplot object. A random of ten working patterns are displayed, +#' - `"plot"`: 'ggplot' object. A random of ten working patterns are displayed, #' with diagnostic data and the Flexibility Index shown on the plot. #' - `"data"`: data frame. The original input data appended with the #' Flexibility Index and the component scores. Can be used with diff --git a/R/hrvar_count.R b/R/hrvar_count.R index d84726c6..b37cc1a2 100644 --- a/R/hrvar_count.R +++ b/R/hrvar_count.R @@ -25,7 +25,7 @@ #' @return #' A different output is returned depending on the value passed to the `return` #' argument: -#' - `"plot"`: ggplot object containing a bar plot. +#' - `"plot"`: 'ggplot' object containing a bar plot. #' - `"table"`: data frame containing a count table. #' #' @import ggplot2 diff --git a/R/network_g2g.R b/R/network_g2g.R index 35620cf4..1fb0f813 100644 --- a/R/network_g2g.R +++ b/R/network_g2g.R @@ -47,9 +47,9 @@ #' @return #' A different output is returned depending on the value passed to the `return` #' argument: -#' - `"plot"`: ggplot object. A group-to-group network plot. +#' - `"plot"`: 'ggplot' object. A group-to-group network plot. #' - `"table"`: data frame. An interactive matrix of the network. -#' - `"network`: igraph object used for creating the network plot. +#' - `"network`: 'igraph' object used for creating the network plot. #' - `"data"`: data frame. A long table of the underlying data. #' #' @import ggplot2 @@ -212,7 +212,7 @@ network_g2g <- function(data, if(return == "network"){ - mynet_em # Return igraph object + mynet_em # Return 'igraph' object } else { diff --git a/R/network_leiden.R b/R/network_leiden.R index 7805ec60..92eff0f1 100644 --- a/R/network_leiden.R +++ b/R/network_leiden.R @@ -31,7 +31,7 @@ #' - `'describe'`: return a list of data frames which describe each of the #' identified communities. The first data frame is a summary table of all the #' communities. -#' - `'network'`: return igraph object. +#' - `'network'`: return 'igraph' object. #' #' @return See `return`. #' diff --git a/R/network_louvain.R b/R/network_louvain.R index b8dabf6d..06bc6bea 100644 --- a/R/network_louvain.R +++ b/R/network_louvain.R @@ -30,7 +30,7 @@ #' - `'describe'`: return a list of data frames which describe each of the #' identified communities. The first data frame is a summary table of all the #' communities. -#' - `'network'`: return igraph object. +#' - `'network'`: return 'igraph' object. #' #' @return See `return`. #' diff --git a/R/network_p2p.R b/R/network_p2p.R index 5bbcec0d..f52b0c9a 100644 --- a/R/network_p2p.R +++ b/R/network_p2p.R @@ -39,7 +39,7 @@ #' identified communities. The first data frame is a summary table of all the #' communities. This is only valid if a community detection method is selected #' at `display`. -#' - `'network'`: return igraph object. +#' - `'network'`: return 'igraph' object. #' #' @param path File path for saving the PDF output. Defaults to a timestamped #' path based on current parameters. @@ -168,7 +168,7 @@ network_p2p <- function(data, ) - ## Create igraph object + ## Create 'igraph' object g_raw <- igraph::graph_from_data_frame(edges, directed = TRUE, # Directed, but FALSE for visualization diff --git a/R/personas_hclust.R b/R/personas_hclust.R index f3c9d33f..f0fa00d1 100644 --- a/R/personas_hclust.R +++ b/R/personas_hclust.R @@ -30,11 +30,11 @@ #' @return #' A different output is returned depending on the value passed to the `return` #' argument: -#' - `"plot"`: ggplot object. A heatmap plot comparing the key metric averages +#' - `"plot"`: 'ggplot' object. A heatmap plot comparing the key metric averages #' of the clusters as per `keymetrics_scan()`. #' - `"data"`: data frame. Raw data with clusters appended #' - `"table"`: data frame. Summary table for identified clusters -#' - `"hclust"`: hclust object. hierarchical model generated by the function. +#' - `"hclust"`: 'hclust' object. hierarchical model generated by the function. #' #' @import dplyr #' @import tidyselect diff --git a/man/afterhours_dist.Rd b/man/afterhours_dist.Rd index 4cba8955..79e487c6 100644 --- a/man/afterhours_dist.Rd +++ b/man/afterhours_dist.Rd @@ -38,7 +38,7 @@ or a numeric value of length three to specify the exact breaks to use. e.g. c(1, \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{"plot"}: 'ggplot' object. A stacked bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/afterhours_fizz.Rd b/man/afterhours_fizz.Rd index c58a0780..686cabc6 100644 --- a/man/afterhours_fizz.Rd +++ b/man/afterhours_fizz.Rd @@ -27,7 +27,7 @@ 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{"plot"}: 'ggplot' object. A jittered scatter plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/afterhours_line.Rd b/man/afterhours_line.Rd index 0cd8e0a3..4c82c7b9 100644 --- a/man/afterhours_line.Rd +++ b/man/afterhours_line.Rd @@ -27,7 +27,7 @@ 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 faceted line plot for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted line plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/afterhours_summary.Rd b/man/afterhours_summary.Rd index e4cc2673..bf9cb1be 100644 --- a/man/afterhours_summary.Rd +++ b/man/afterhours_summary.Rd @@ -31,7 +31,7 @@ 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 bar plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/afterhours_trend.Rd b/man/afterhours_trend.Rd index 87fd9d6d..faab25a9 100644 --- a/man/afterhours_trend.Rd +++ b/man/afterhours_trend.Rd @@ -20,7 +20,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/collaboration_area.Rd b/man/collaboration_area.Rd index 341789a7..8bed6fdc 100644 --- a/man/collaboration_area.Rd +++ b/man/collaboration_area.Rd @@ -33,7 +33,7 @@ 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 stacked area plot for the metric. +\item \code{"plot"}: 'ggplot' object. A stacked area plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/collaboration_dist.Rd b/man/collaboration_dist.Rd index 2940a6bf..8ef2a4a4 100644 --- a/man/collaboration_dist.Rd +++ b/man/collaboration_dist.Rd @@ -47,7 +47,7 @@ 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{"plot"}: 'ggplot' object. A stacked bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/collaboration_fizz.Rd b/man/collaboration_fizz.Rd index 47f9c098..f53c07cb 100644 --- a/man/collaboration_fizz.Rd +++ b/man/collaboration_fizz.Rd @@ -30,7 +30,7 @@ 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{"plot"}: 'ggplot' object. A jittered scatter plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/collaboration_line.Rd b/man/collaboration_line.Rd index 25c67260..62e4bb72 100644 --- a/man/collaboration_line.Rd +++ b/man/collaboration_line.Rd @@ -30,7 +30,7 @@ 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 faceted line plot for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted line plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/collaboration_rank.Rd b/man/collaboration_rank.Rd index e3c8aab0..9f404c0e 100644 --- a/man/collaboration_rank.Rd +++ b/man/collaboration_rank.Rd @@ -59,7 +59,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the +\item \code{"plot"}: 'ggplot' object. A bubble plot where the x-axis represents the metric, the y-axis represents the HR attributes, and the size of the bubbles represent the size of the organizations. Note that there is no plot output if \code{mode} is set to \code{"combine"}. diff --git a/man/collaboration_sum.Rd b/man/collaboration_sum.Rd index c0ee9c15..84f73758 100644 --- a/man/collaboration_sum.Rd +++ b/man/collaboration_sum.Rd @@ -34,7 +34,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/collaboration_trend.Rd b/man/collaboration_trend.Rd index 103d644c..2a5c0e3e 100644 --- a/man/collaboration_trend.Rd +++ b/man/collaboration_trend.Rd @@ -25,7 +25,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/create_IV.Rd b/man/create_IV.Rd index e5cb35c4..4f868673 100644 --- a/man/create_IV.Rd +++ b/man/create_IV.Rd @@ -43,11 +43,11 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bar plot showing the IV value of the top +\item \code{"plot"}: 'ggplot' object. A bar plot showing the IV value of the top (maximum 12) variables. \item \code{"summary"}: data frame. A summary table for the metric. \item \code{"list"}: list. A list of outputs for all the input variables. -\item \code{"plot-WOE"}: A list of ggplot objects that show the WOE for each +\item \code{"plot-WOE"}: A list of 'ggplot' objects that show the WOE for each predictor used in the model. \item \code{"IV"} returns the original Information object returned by \code{Information::create_infotables()}. diff --git a/man/create_bar.Rd b/man/create_bar.Rd index 44ffa128..10046ef1 100644 --- a/man/create_bar.Rd +++ b/man/create_bar.Rd @@ -47,7 +47,7 @@ before the computation proceeds. Defaults to \code{FALSE}.} \value{ A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bar plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/create_bar_asis.Rd b/man/create_bar_asis.Rd index 63bc1d49..9a7191a1 100644 --- a/man/create_bar_asis.Rd +++ b/man/create_bar_asis.Rd @@ -48,7 +48,7 @@ RGB values via \code{rgb2hex()}.} labels} } \value{ -ggplot object. A horizontal bar plot. +'ggplot' object. A horizontal bar plot. } \description{ This function creates a bar chart directly from the aggregated / summarised diff --git a/man/create_boxplot.Rd b/man/create_boxplot.Rd index 27f12127..583528ee 100644 --- a/man/create_boxplot.Rd +++ b/man/create_boxplot.Rd @@ -37,7 +37,7 @@ 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 box plot for the metric. +\item \code{"plot"}: 'ggplot' object. A box plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/create_bubble.Rd b/man/create_bubble.Rd index 93e1941d..228c824a 100644 --- a/man/create_bubble.Rd +++ b/man/create_bubble.Rd @@ -41,7 +41,7 @@ of the bubbles} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bubble plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/create_dist.Rd b/man/create_dist.Rd index fb518ee4..a88e91ac 100644 --- a/man/create_dist.Rd +++ b/man/create_dist.Rd @@ -50,7 +50,7 @@ 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: \itemize{ -\item \code{"plot"}: ggplot object. A stacked bar plot for the metric. +\item \code{"plot"}: 'ggplot' object. A stacked bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/create_fizz.Rd b/man/create_fizz.Rd index b4018e25..18d7c049 100644 --- a/man/create_fizz.Rd +++ b/man/create_fizz.Rd @@ -36,7 +36,7 @@ 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{"plot"}: 'ggplot' object. A jittered scatter plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/create_hist.Rd b/man/create_hist.Rd index 754abc49..06b0d340 100644 --- a/man/create_hist.Rd +++ b/man/create_hist.Rd @@ -44,7 +44,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A faceted histogram for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted histogram for the metric. \item \code{"table"}: data frame. A summary table for the metric. \item \code{"data"}: data frame. Data with calculated person averages. \item \verb{"frequency}: list of data frames. Each data frame contains the diff --git a/man/create_line.Rd b/man/create_line.Rd index bc1ec91b..8970b5ab 100644 --- a/man/create_line.Rd +++ b/man/create_line.Rd @@ -36,7 +36,7 @@ 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 faceted line plot for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted line plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/create_rank.Rd b/man/create_rank.Rd index d7caed76..2d46d8e8 100644 --- a/man/create_rank.Rd +++ b/man/create_rank.Rd @@ -53,7 +53,7 @@ be either \code{1} or \code{2}, and is only used when \code{return = "plot"}. A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the +\item \code{"plot"}: 'ggplot' object. A bubble plot where the x-axis represents the metric, the y-axis represents the HR attributes, and the size of the bubbles represent the size of the organizations. Note that there is no plot output if \code{mode} is set to \code{"combine"}. diff --git a/man/create_scatter.Rd b/man/create_scatter.Rd index 97c96df7..c5d1b6d9 100644 --- a/man/create_scatter.Rd +++ b/man/create_scatter.Rd @@ -31,7 +31,7 @@ but accepts any character vector, e.g. "LevelDesignation"} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/create_stacked.Rd b/man/create_stacked.Rd index ee982456..4db76ef0 100644 --- a/man/create_stacked.Rd +++ b/man/create_stacked.Rd @@ -40,7 +40,7 @@ Valid inputs are "plot" and "table".} \item{plot_subtitle}{An option to override plot subtitle.} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/create_trend.Rd b/man/create_trend.Rd index 0b96f8ea..da286b9f 100644 --- a/man/create_trend.Rd +++ b/man/create_trend.Rd @@ -29,7 +29,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/email_dist.Rd b/man/email_dist.Rd index 13912e06..4dd7a5c7 100644 --- a/man/email_dist.Rd +++ b/man/email_dist.Rd @@ -38,7 +38,7 @@ 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{"plot"}: 'ggplot' object. A stacked bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/email_fizz.Rd b/man/email_fizz.Rd index 29938482..7618bffb 100644 --- a/man/email_fizz.Rd +++ b/man/email_fizz.Rd @@ -27,7 +27,7 @@ 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{"plot"}: 'ggplot' object. A jittered scatter plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/email_line.Rd b/man/email_line.Rd index 68465875..c576f477 100644 --- a/man/email_line.Rd +++ b/man/email_line.Rd @@ -27,7 +27,7 @@ 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 faceted line plot for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted line plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/email_rank.Rd b/man/email_rank.Rd index b4ade436..8173422b 100644 --- a/man/email_rank.Rd +++ b/man/email_rank.Rd @@ -49,7 +49,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the +\item \code{"plot"}: 'ggplot' object. A bubble plot where the x-axis represents the metric, the y-axis represents the HR attributes, and the size of the bubbles represent the size of the organizations. Note that there is no plot output if \code{mode} is set to \code{"combine"}. diff --git a/man/email_summary.Rd b/man/email_summary.Rd index d463629e..46fe7ac2 100644 --- a/man/email_summary.Rd +++ b/man/email_summary.Rd @@ -31,7 +31,7 @@ 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 bar plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/email_trend.Rd b/man/email_trend.Rd index 30ac96d0..9f4522ec 100644 --- a/man/email_trend.Rd +++ b/man/email_trend.Rd @@ -20,7 +20,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/export.Rd b/man/export.Rd index 2dbf2a85..c40ff8cc 100644 --- a/man/export.Rd +++ b/man/export.Rd @@ -14,14 +14,14 @@ export( ) } \arguments{ -\item{x}{Data frame or ggplot object to be passed through.} +\item{x}{Data frame or 'ggplot' object to be passed through.} \item{method}{Character string specifying the method of export. Valid inputs include: \itemize{ \item \code{"clipboard"} (default if input is data frame) \item \code{"csv"} -\item \code{"png"} (default if input is ggplot object) +\item \code{"png"} (default if input is 'ggplot' object) \item \code{"svg"} \item \code{"jpeg"} \item \code{"pdf"} @@ -43,16 +43,16 @@ argument: \itemize{ \item \code{"clipboard"}: no return - data frame is saved to clipboard. \item \code{"csv"}: CSV file containing data frame is saved to specified path. -\item \code{"png"}: PNG file containing ggplot object is saved to specified path. -\item \code{"svg"}: SVG file containing ggplot object is saved to specified path. -\item \code{"jpeg"}: JPEG file containing ggplot object is saved to specified path. -\item \code{"pdf"}: PDF file containing ggplot object is saved to specified path. +\item \code{"png"}: PNG file containing 'ggplot' object is saved to specified path. +\item \code{"svg"}: SVG file containing 'ggplot' object is saved to specified path. +\item \code{"jpeg"}: JPEG file containing 'ggplot' object is saved to specified path. +\item \code{"pdf"}: PDF file containing 'ggplot' object is saved to specified path. } } \description{ A general use function to export {wpa} outputs to CSV, clipboard, or save as images. By default, \code{export()} copies -a data frame to the clipboard. If the input is a ggplot object, +a data frame to the clipboard. If the input is a 'ggplot' object, the default behaviour is to export a PNG. } \seealso{ diff --git a/man/flex_index.Rd b/man/flex_index.Rd index 65642841..f71d1449 100644 --- a/man/flex_index.Rd +++ b/man/flex_index.Rd @@ -53,7 +53,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A random of ten working patterns are displayed, +\item \code{"plot"}: 'ggplot' object. A random of ten working patterns are displayed, with diagnostic data and the Flexibility Index shown on the plot. \item \code{"data"}: data frame. The original input data appended with the Flexibility Index and the component scores. Can be used with diff --git a/man/hrvar_count.Rd b/man/hrvar_count.Rd index 5550222c..78d30460 100644 --- a/man/hrvar_count.Rd +++ b/man/hrvar_count.Rd @@ -30,7 +30,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object containing a bar plot. +\item \code{"plot"}: 'ggplot' object containing a bar plot. \item \code{"table"}: data frame containing a count table. } } diff --git a/man/meeting_dist.Rd b/man/meeting_dist.Rd index c73b1bd2..30b297c0 100644 --- a/man/meeting_dist.Rd +++ b/man/meeting_dist.Rd @@ -38,7 +38,7 @@ 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{"plot"}: 'ggplot' object. A stacked bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/meeting_line.Rd b/man/meeting_line.Rd index 257a72d4..c051fe2f 100644 --- a/man/meeting_line.Rd +++ b/man/meeting_line.Rd @@ -27,7 +27,7 @@ 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 faceted line plot for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted line plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/meeting_quality.Rd b/man/meeting_quality.Rd index c5943722..da3587c8 100644 --- a/man/meeting_quality.Rd +++ b/man/meeting_quality.Rd @@ -38,7 +38,7 @@ following strings: - \code{"plot"} - \code{"table"}} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bubble plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/meeting_rank.Rd b/man/meeting_rank.Rd index 80b68921..74ceb5ca 100644 --- a/man/meeting_rank.Rd +++ b/man/meeting_rank.Rd @@ -49,7 +49,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the +\item \code{"plot"}: 'ggplot' object. A bubble plot where the x-axis represents the metric, the y-axis represents the HR attributes, and the size of the bubbles represent the size of the organizations. Note that there is no plot output if \code{mode} is set to \code{"combine"}. diff --git a/man/meeting_summary.Rd b/man/meeting_summary.Rd index ce195ce7..2c464ee3 100644 --- a/man/meeting_summary.Rd +++ b/man/meeting_summary.Rd @@ -31,7 +31,7 @@ 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 bar plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/meeting_trend.Rd b/man/meeting_trend.Rd index bdb99915..3948c907 100644 --- a/man/meeting_trend.Rd +++ b/man/meeting_trend.Rd @@ -20,7 +20,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/network_g2g.Rd b/man/network_g2g.Rd index e8f5c708..754e0c1e 100644 --- a/man/network_g2g.Rd +++ b/man/network_g2g.Rd @@ -82,9 +82,9 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A group-to-group network plot. +\item \code{"plot"}: 'ggplot' object. A group-to-group network plot. \item \code{"table"}: data frame. An interactive matrix of the network. -\item \verb{"network}: igraph object used for creating the network plot. +\item \verb{"network}: 'igraph' object used for creating the network plot. \item \code{"data"}: data frame. A long table of the underlying data. } } diff --git a/man/network_leiden.Rd b/man/network_leiden.Rd index 6c5bb55e..a006e2cf 100644 --- a/man/network_leiden.Rd +++ b/man/network_leiden.Rd @@ -66,7 +66,7 @@ communities and HR attributes. \item \code{'describe'}: return a list of data frames which describe each of the identified communities. The first data frame is a summary table of all the communities. -\item \code{'network'}: return igraph object. +\item \code{'network'}: return 'igraph' object. }} \item{size_threshold}{Numeric value representing the maximum number of edges diff --git a/man/network_louvain.Rd b/man/network_louvain.Rd index d75404e2..06a5cab6 100644 --- a/man/network_louvain.Rd +++ b/man/network_louvain.Rd @@ -58,7 +58,7 @@ communities and HR attributes. \item \code{'describe'}: return a list of data frames which describe each of the identified communities. The first data frame is a summary table of all the communities. -\item \code{'network'}: return igraph object. +\item \code{'network'}: return 'igraph' object. }} \item{size_threshold}{Numeric value representing the maximum number of edges diff --git a/man/network_p2p.Rd b/man/network_p2p.Rd index a8d697d3..052723e2 100644 --- a/man/network_p2p.Rd +++ b/man/network_p2p.Rd @@ -54,7 +54,7 @@ communities and HR attributes. identified communities. The first data frame is a summary table of all the communities. This is only valid if a community detection method is selected at \code{display}. -\item \code{'network'}: return igraph object. +\item \code{'network'}: return 'igraph' object. }} \item{path}{File path for saving the PDF output. Defaults to a timestamped diff --git a/man/one2one_dist.Rd b/man/one2one_dist.Rd index 15194c79..175c7262 100644 --- a/man/one2one_dist.Rd +++ b/man/one2one_dist.Rd @@ -38,7 +38,7 @@ 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{"plot"}: 'ggplot' object. A stacked bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/one2one_fizz.Rd b/man/one2one_fizz.Rd index e28c6c61..3092fa4f 100644 --- a/man/one2one_fizz.Rd +++ b/man/one2one_fizz.Rd @@ -27,7 +27,7 @@ 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{"plot"}: 'ggplot' object. A jittered scatter plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/one2one_line.Rd b/man/one2one_line.Rd index b85a8930..1c64fdda 100644 --- a/man/one2one_line.Rd +++ b/man/one2one_line.Rd @@ -27,7 +27,7 @@ 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 faceted line plot for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted line plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/one2one_rank.Rd b/man/one2one_rank.Rd index f492b452..e6faf8bd 100644 --- a/man/one2one_rank.Rd +++ b/man/one2one_rank.Rd @@ -49,7 +49,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the +\item \code{"plot"}: 'ggplot' object. A bubble plot where the x-axis represents the metric, the y-axis represents the HR attributes, and the size of the bubbles represent the size of the organizations. Note that there is no plot output if \code{mode} is set to \code{"combine"}. diff --git a/man/one2one_sum.Rd b/man/one2one_sum.Rd index 3fb3bdf7..6c5bed84 100644 --- a/man/one2one_sum.Rd +++ b/man/one2one_sum.Rd @@ -31,7 +31,7 @@ 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 bar plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/one2one_trend.Rd b/man/one2one_trend.Rd index 769a8577..e5976cee 100644 --- a/man/one2one_trend.Rd +++ b/man/one2one_trend.Rd @@ -20,7 +20,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{ diff --git a/man/personas_hclust.Rd b/man/personas_hclust.Rd index fdede470..257fcd48 100644 --- a/man/personas_hclust.Rd +++ b/man/personas_hclust.Rd @@ -30,11 +30,11 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A heatmap plot comparing the key metric averages +\item \code{"plot"}: 'ggplot' object. A heatmap plot comparing the key metric averages of the clusters as per \code{keymetrics_scan()}. \item \code{"data"}: data frame. Raw data with clusters appended \item \code{"table"}: data frame. Summary table for identified clusters -\item \code{"hclust"}: hclust object. hierarchical model generated by the function. +\item \code{"hclust"}: 'hclust' object. hierarchical model generated by the function. } } \description{ diff --git a/man/plot_WOE.Rd b/man/plot_WOE.Rd index bff1fb60..1b395115 100644 --- a/man/plot_WOE.Rd +++ b/man/plot_WOE.Rd @@ -12,7 +12,7 @@ plot_WOE(IV, predictor) \item{predictor}{String with the name of the predictor variable.} } \value{ -ggplot object. Bar plot with 'WOE' as the y-axis and bins of the predictor +'ggplot' object. Bar plot with 'WOE' as the y-axis and bins of the predictor variable as the horizontal axis. } \description{ diff --git a/man/workloads_dist.Rd b/man/workloads_dist.Rd index 02bdeeae..5fb622cb 100644 --- a/man/workloads_dist.Rd +++ b/man/workloads_dist.Rd @@ -38,7 +38,7 @@ 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{"plot"}: 'ggplot' object. A stacked bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/workloads_fizz.Rd b/man/workloads_fizz.Rd index 7d548efd..196529d8 100644 --- a/man/workloads_fizz.Rd +++ b/man/workloads_fizz.Rd @@ -27,7 +27,7 @@ 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{"plot"}: 'ggplot' object. A jittered scatter plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/workloads_line.Rd b/man/workloads_line.Rd index 13c7a7f6..6626afa7 100644 --- a/man/workloads_line.Rd +++ b/man/workloads_line.Rd @@ -27,7 +27,7 @@ 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 faceted line plot for the metric. +\item \code{"plot"}: 'ggplot' object. A faceted line plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/workloads_rank.Rd b/man/workloads_rank.Rd index e5b08cdd..ae14d4ca 100644 --- a/man/workloads_rank.Rd +++ b/man/workloads_rank.Rd @@ -49,7 +49,7 @@ See \code{Value} for more information.} A different output is returned depending on the value passed to the \code{return} argument: \itemize{ -\item \code{"plot"}: ggplot object. A bubble plot where the x-axis represents the +\item \code{"plot"}: 'ggplot' object. A bubble plot where the x-axis represents the metric, the y-axis represents the HR attributes, and the size of the bubbles represent the size of the organizations. Note that there is no plot output if \code{mode} is set to \code{"combine"}. diff --git a/man/workloads_summary.Rd b/man/workloads_summary.Rd index 415c879f..6a85d7cd 100644 --- a/man/workloads_summary.Rd +++ b/man/workloads_summary.Rd @@ -31,7 +31,7 @@ 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 bar plot for the metric. +\item \code{"plot"}: 'ggplot' object. A bar plot for the metric. \item \code{"table"}: data frame. A summary table for the metric. } } diff --git a/man/workloads_trend.Rd b/man/workloads_trend.Rd index 600fbc3d..48bfe2bb 100644 --- a/man/workloads_trend.Rd +++ b/man/workloads_trend.Rd @@ -20,7 +20,7 @@ size. Defaults to 5.} Valid inputs are "plot" and "table".} } \value{ -Returns a ggplot object by default, where 'plot' is passed in \code{return}. +Returns a 'ggplot' object by default, where 'plot' is passed in \code{return}. When 'table' is passed, a summary table is returned as a data frame. } \description{