Skip to contents

Create a groupedbar mschart object

ms_grouped_y2.Rd

This function creates a mschart object automatically formatted for a grouped variable. It requires two lists called "text_settings_grouped" and "color_settings_grouped" by default that specify the colors desired for the chart.

Usage

ms_grouped_y2(
  data = frequencies,
  x_var = "label",
  y_var = "result",
  group_var = "group_var",
  axis_text_size = 10,
  axis_title_size = 18,
  axis_x_display = TRUE,
  axis_x_label = "",
  axis_x_position = c("nextTo", "high", "low", "none"),
  axis_x_rotate = 0,
  axis_x_rotate_title = 0,
  axis_y_display = FALSE,
  axis_y_label = "",
  axis_y_min = 0,
  axis_y_max = NULL,
  axis_y_rotate = 0,
  axis_y_rotate_title = 0,
  direction = c("vertical", "horizontal"),
  font_family = "BentonSans Regular",
  gap_width = 75,
  grouping = "standard",
  label_color = color_settings_grouped,
  label_position = c("outEnd", "inEnd", "ctr", "inBase"),
  label_show_values = TRUE,
  label_text = text_settings_grouped,
  overlapping = -25,
  legend_pos = c("t", "n", "b", "tr", "l", "r"),
  legend_text_size = 12,
  num_fmt = c("percent", "general"),
  title_label = "",
  title_size = 18
)

Arguments

data

DEFAULT = frequencies; The name of the data frame that the mscharts pulls from.

x_var

DEFAULT = 'label'; When using the freqs function, will typically be label (is by default).

y_var

DEFAULT = 'result'; When using the freqs function, will typically be result (is by default).

group_var

DEFAULT = 'group_var'; All levels of the group_var must be present or the chart may break. To do this, save the variable as_factor() before running freqs. Also remember that label_text and label_color must exactly match all the levels of the group_var or the function will break.

axis_text_size

DEFAULT = 10; Font size for variable levels and percentages.

axis_title_size

DEFAULT = 18; Font size for axis_x_label and axis_y_label.

axis_x_display, axis_y_display

DEFAULT = TRUE for x axis, DEFAULT = FALSE for y axis

axis_x_label, axis_y_label

DEFAULT = ”; Title for the x_axis and y_axis

axis_x_position

DEFAULT = 'nextTo'; Other options include "high", "low", "none". Change to "low" if dealing with negative numbers

axis_x_rotate, axis_y_rotate

DEFAULT = 0; Rotation of axis text. Set to -45 for diagonal, giving more space for text.

axis_x_rotate_title, axis_y_rotate_title

DEFAULT = 0, set y_axis rotation to 360 for horizontal text

axis_y_min

DEFAULT = 0 to show full data without skewing perspective, but can be adjusted.

axis_y_max

DEFAULT = NULL

direction

DEFAULT = 'vertical'; Two options: "vertical" (default) OR "horizontal"

font_family

DEFAULT = 'BentonSans Regular' (Qualtrics font). Sets the fonts for axis, legends, and titles. Label font is set within label_color and label_text lists. May specify fonts in quotes, e.g. "Times New Roman"

gap_width

DEFAULT = 25, meaning the size of the space between bars is 25% the size of the bar itself

grouping

DEFAULT = 'standard'; grouping for a barchart, a linechart or an area chart. must be one of "percentStacked", "clustered", "standard" or "stacked".

label_color

DEFAULT = color_settings_grouped; A list of color settings for the bars. This affects font size and color. Specified outside of the function. If a list of one, no need to specify values. Otherwise, they must exactly match the group_var levels. Example: color_settings_grouped <- list('Name of Group 1' = lime,'Name of Group 2' = brightblue)

label_position

DEFAULT = 'outEnd'; Other options include c('outEnd', 'inEnd', 'ctr', 'inBase')

label_show_values

DEFAULT = TRUE; TRUE or FALSE. Show percent labels for each value.

label_text

DEFAULT = text_settings_grouped; A list of text settings for the percent labels. This affects font size and color. Specified outside of the function. If a list of one, no need to specify values. Otherwise, they must exactly match the group_var levels. Example: text_settings_grouped <- list('Name of Group 1' = fp_text(font.size = 16, color = lime),'Name of Group 2' = fp_text(font.size = 16, color = brightblue))

overlapping

DEFAULT = -50 This leaves 50% extra space between variable levels. Set to 100 when coloring bars different colors.

legend_pos

DEFAULT = 't' for top; Other legend positions are 'b', 'tr', 'l', 'r', and 'n' for none.

legend_text_size

DEFAULT = 12

num_fmt

DEFAULT = 'percent'; Can also be set to 'general' for non-percentages. Changes formatting for both the labels and axis

title_label

DEFAULT = ”; Add your title in "" as the title of the chart.

title_size

DEFAULT = 18

Examples

frequencies <- ToothGrowth %>%
  dplyr::group_by(supp) %>%
  y2clerk::freqs(dose) %>%
  orderlabel::order_label(group_var = group_var)
#> Adding missing grouping variables: `supp`

color_settings_grouped <- list(
  'OJ' = 'orange',
  'VC' = 'gray'
)
text_settings_grouped <- list(
  'OJ' = officer::fp_text(color = 'orange', font.size = 20),
  'VC' = officer::fp_text(color = 'gray', font.size = 20)
)

chart <- ms_grouped_y2()
#> Error in ms_grouped_y2(): object 'frequencies' not found
print(chart, preview = TRUE)
#> Error: object 'chart' not found