add_violin: Add a violin plot to a chronicle report

In chronicle: Grammar for Creating R Markdown Reports

Description

Add a violin plot to a chronicle report

Usage

add_violin(
  report = "",
  dt,
  value,
  groups = NULL,
  jitter = NULL,
  ggtheme = NULL,
  x_axis_label = NULL,
  y_axis_label = NULL,
  plot_palette = NULL,
  plot_palette_generator = NULL,
  violin_title = NULL,
  title_level = 2,
  echo = FALSE,
  message = FALSE,
  warning = FALSE,
  fig_width = NULL,
  fig_height = NULL
)

Arguments

report	Character string containing all the R Markdown chunks previously added. Default is ”, an empty report.
dt	Table with the data for the plot.
value	Name of the column to use as values on the y axis of the plot.
groups	Name of the column containing the different groups.
jitter	Whether to add the actual values of each observation over the violin plots. Only done when dt has 1000 rows or less.
ggtheme	ggplot2 theme function to apply. Default is ggplot2::theme_minimal.
x_axis_label	Label for the x axis.
y_axis_label	Label for the y axis.
plot_palette	Character vector of hex codes specifying the colors to use on the plot.
plot_palette_generator	Palette from the viridis package used in case plot_palette is unspecified or insufficient for the number of colors required.
violin_title	Title of the violin plot section on the report. If NULL, chronicle will try to parse a generic title using make_title()
title_level	Level of the section title of this plot (ie, number of # on Rmarkdown syntax.)
echo	Whether to display the source code in the output document. Default is FALSE.
message	Whether to preserve messages on rendering. Default is FALSE.
warning	Whether to preserve warnings on rendering. Default is FALSE.
fig_width	Width of the plot (in inches).
fig_height	Height of the plot (in inches).

Value

An rmarkdown chunk as a character string, now containing a chunk for adding the violin plot.

Examples

html_report <- add_violin(report = "",
                             dt = iris,
                             value = 'Sepal.Length',
                             groups = 'Species', jitter = TRUE)
cat(html_report)

chronicle documentation built on June 25, 2021, 9:09 a.m.