Function wraps around ggplot2 geom_boxplot to create a box plot.
create_box_plot(
df = NULL,
aes_x = NULL,
aes_y = NULL,
aes_color = NULL,
aes_fill = NULL,
aes_label = NULL,
title = NULL,
subtitle = NULL,
caption = NULL,
center_titles = FALSE,
x_title = NULL,
y_title = NULL,
hide_x_tics = FALSE,
hide_y_tics = FALSE,
rot_x_tic_angle = 0,
rot_y_tic_label = FALSE,
box_fill = NA,
box_color = "black",
box_line_width = 0.5,
box_alpha = 1,
y_limits = NULL,
y_major_breaks = waiver(),
y_minor_breaks = waiver(),
y_decimals = 0,
y_scientific = FALSE,
axis_text_size = 11,
do_coord_flip = FALSE,
show_legend = TRUE,
panel_color = "white",
panel_border_color = "black",
legend_pos = "top",
legend_key_width = 0.7,
legend_key_height = 0.7,
legend_key_backgrd = "white",
show_major_grids = TRUE,
show_minor_grids = TRUE,
ol_color = "black",
ol_fill = "black",
ol_size = 1.5,
ol_shape = 19,
ol_stroke = 0.5,
ol_alpha = NULL,
order_by_median = NULL,
silent_NA_warning = FALSE,
png_file_path = NULL,
png_width_height = c(480, 480)
)
A ggplot class object.
The target data frame for the density chart.
An optional factor variable name from 'df' that sets the x axis variable. Multiple box plots will be displayed along the x axis if this argument is set.
A required variable name from 'df' that sets the y axis variable.
Sets the variable name from 'df' for the aesthetic mapping for color.
Sets the variable name from 'df' for the aesthetic mapping for fill.
Sets the variable name from 'df' whose value will to be displayed corresponding to the 'aes_y' outliers.
A string that sets the overall title.
A string that sets the overall subtitle
A string that sets the plot caption
A logical which if TRUE
centers both the 'title' and 'subtitle'.
A string that sets the x axis title. If NULL
(the default) then the x axis title does not appear.
A string that sets the y axis title. If NULL
(the default) then the y axis title does not appear.
A logical that controls the appearance of the x axis tics.
A logical that controls the appearance of the y axis tics.
A numeric that sets the angle of rotation for the x tic labels. When x tic labels are long, a value of 40 for this argument usually works well.
A logical which if TRUE rotates the y tic labels 90 degrees for enhanced readability.
A string that sets the fill color attribute for the box plot.
A string that sets the color attribute for the box plot.
A numeric that sets the size attribute of the box line width.
A numeric that set the alpha component attribute to 'box_color'.
A numeric 2 element vector that sets the minimum and maximum for the y axis.
Use NA
to refer to the existing minimum and maximum.
A numeric vector or function that defines the exact major tic locations along the y axis.
A numeric vector or function that defines the exact minor tic locations along the y axis.
A numeric that sets the number of decimal places for y-tic labels.
A logical which if TRUE
will put the y-tic labels in scientific notation.
A numeric that sets the font size along the axis'. Default is 11.
A logical which if TRUE
will flip the x and y axis'.
A logical that controls the appearance of the legend.
A string in hexidecimal or color name that sets the plot panel's color. The default is "white".
A string in hexidecimal or color name that sets the plot panel's border color. The default is "black".
A string that sets the legend position. Acceptable values are "top", "bottom", "left", "right".
A numeric that sets the legend width in cm.
A numeric that sets the legend height in cm.
A string that sets the legend's background color. The default is "white".
A logical that controls the appearance of major grids.
A logical that controls the appearance of minor grids.
A string that sets the outlier color.
A string that sets the outlier fill.
A numeric that set the outlier size.
A string that set the outlier shape.
A numeric that sets the outlier shape line width.
A numeric that sets the outlier alpha for color.
A string which will order the plot of 'aes_x' factor levels/categories by the 'aes_y' medians.
Acceptable values are "asc" or "desc". Note that the optional argument 'aes_x' must not be NULL
.
A logical that controls the appearance of a console warning when Na's are removed.
A character string with the directory and file name to produce a png image of the plot.
A numeric vector that sets the width and height of the png image in pixels. The default is c(480,480). There are 37.8 pixels in a centimeter.
library(ggplot2)
library(data.table)
library(RplotterPkg)
RplotterPkg::create_box_plot(
df = RplotterPkg::organdata,
aes_x = "country",
aes_y = "donors",
aes_label = "donors",
order_by_median = "desc",
y_limits = c(5,35),
y_major_breaks = seq(5, 35, 5),
title = "Organ Donation Rate per Million",
subtitle = "Showing outlier rates",
x_title = "Country",
y_title = "Donor Rate",
do_coord_flip = TRUE,
box_color = "purple",
box_line_width = 0.8,
rot_y_tic_label = TRUE,
ol_color = "red",
ol_size = 1.5
)
Run the code above in your browser using DataLab