docs: package names in single quotes

This commit is contained in:
Martin Chan 2021-03-30 17:40:16 +01:00
Родитель 87f6d82b19
Коммит f933ba6a04
83 изменённых файлов: 105 добавлений и 105 удалений

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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"`.

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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"
}

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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 {

Просмотреть файл

@ -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`.
#'

Просмотреть файл

@ -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`.
#'

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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{

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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"}.

Просмотреть файл

@ -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{

Просмотреть файл

@ -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{

Просмотреть файл

@ -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()}.

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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"}.

Просмотреть файл

@ -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{

Просмотреть файл

@ -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{

Просмотреть файл

@ -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{

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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"}.

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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{

Просмотреть файл

@ -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{

Просмотреть файл

@ -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

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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"}.

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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{

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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"}.

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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{

Просмотреть файл

@ -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{

Просмотреть файл

@ -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{

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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"}.

Просмотреть файл

@ -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.
}
}

Просмотреть файл

@ -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{