makeBarPolarPlot: Create a bar/polar plot

In federicomarini/bettr: A Better Way To Explore What Is Best

Create a bar/polar plot

Description

Create a bar/polar plot. The input arguments for this functions are typically generated using bettrGetReady, which ensures that all required columns are available.

Usage

makeBarPolarPlot(
  bettrList = NULL,
  plotdata,
  scoredata,
  idCol,
  metricCol = "Metric",
  valueCol = "ScaledValue",
  weightCol = "Weight",
  scoreCol = "Score",
  metricGroupCol = "metricGroup",
  metricColors,
  metricCollapseGroup = FALSE,
  metricGrouping = "---",
  methods = NULL,
  labelSize = 10,
  showComposition = FALSE,
  scaleFactorPolars = 1
)

Arguments

bettrList	A list, the output object from prepData. If bettrList is provided, arguments plotdata, scoredata, idCol, metricCol, valueCol, weightCol, scoreCol, metricGroupCol, metricInfo, metricColors, idInfo, idColors, metricCollapseGroup, metricGrouping and methods will be ignored and the corresponding values will be extracted from bettrList. This is the recommended way of calling the plotting functions, as it ensures compatibility of all components.
plotdata	A data.frame with columns representing methods, metrics, scores, and weights. Typically obtained as prepData$plotdata, where prepData is the output from bettrGetReady.
scoredata	A data.frame with columns representing methods, aggregated scores, and any other method annotations. Typically obtained as prepData$scoredata, where prepData is the output from bettrGetReady.
idCol	Character scalar indicating which column of plotdata and scoredata contains the method IDs.
metricCol	Character scalar indicating which column of plotdata contains the metric IDs. Typically, "Metric".
valueCol	Character scalar indicating which column of plotdata contains the metric values. Typically, "ScaledValue".
weightCol	Character scalar indicating which column of plotdata contains the weight values. Typically, "Weight".
scoreCol	Character scalar indicating which column of scoredata contains the aggregated score values. Typically, "Score".
metricGroupCol	Character scalar indicating which column of plotdata contains the information about the metric group. Typically, "metricGroup".
metricColors	Named list with colors used for the metrics and any other metric annotations. Typically obtained as prepData$metricColors, where prepData is the output from bettrGetReady.
metricCollapseGroup	Logical scalar indicating whether metrics should be collapsed by the group variable provided by metricGrouping. Typically obtained as prepData$metricCollapseGroup, where prepData is the output from bettrGetReady.
metricGrouping	Character scalar indicating the column of metricInfo that was used to group metrics. Typically obtained as prepData$metricGrouping, where prepData is the output from bettrGetReady.
methods	Character vector containing the methods for which to make polar plots. If NULL (default), all methods will be used.
labelSize	Numeric scalar providing the size of the labels in the plot.
showComposition	Logical scalar indicating whether to show the composition of the score in the bar plots. This is only interpretable if the scores are obtained via a weighted mean approach.
scaleFactorPolars	Numeric scalar giving the scale factor determining the size of the polar plots.

Value

A ggplot object.

Author(s)

Charlotte Soneson

Examples

## Generate example data
df <- data.frame(Method = c("M1", "M2", "M3"), 
                 metric1 = c(1, 2, 3),
                 metric2 = c(3, 1, 2))
metricInfo <- data.frame(Metric = c("metric1", "metric2", "metric3"),
                         Group = c("G1", "G2", "G2"))
idInfo <- data.frame(Method = c("M1", "M2", "M3"), 
                     Type = c("T1", "T1", "T2"))
prepData <- bettrGetReady(df = df, idCol = "Method", 
                          metricInfo = metricInfo, idInfo = idInfo)
makeBarPolarPlot(bettrList = prepData, showComposition = TRUE)
                 

federicomarini/bettr documentation built on Nov. 5, 2024, 4:33 a.m.