mermaid_boxplot: MERMAID boxplots

In data-mermaid/mermaidreporting: Reporting on MERMAID Data

Description

MERMAID boxplots

Usage

mermaid_boxplot(
  .data,
  group_var,
  group_var_string,
  compare_var,
  compare_var_string,
  y_axis_name,
  clean_values = TRUE,
  clean_values_case = c("title", "sentence"),
  replace_dashes = TRUE
)

Arguments

.data	Sample event data containing mean fish belt biomass, with variables indicated in group_var and compare_var. Likely the output from a mermaid_get_project_data() call.
group_var	Variable to group by, e.g. biomass_kgha_by_trophic_group_avg. Must be a data frame column.
group_var_string	String version of group_var. Internal use only.
compare_var	Variable to compare by, e.g. management_rules
compare_var_string	String version of compare_var. Internal use only.
y_axis_name	Name of the y axis. Internal use only.
clean_values	Whether to clean the values in group_var and compare_var (with title case as default - see clean_values_case), in case they are not clean (e.g. contain dashes, underscores, are lowercase, etc). Defaults to TRUE.
clean_values_case	The desired clean values case (default is "title"). For example, if a value is "invertivore-mobile", title case converts it to "Invertivore Mobile" while sentence case converts it to "Invertivore mobile". If you don't want to replace dashes with spaces (e.g. get "Interivore-Mobile", set replace_dashes = FALSE.
replace_dashes	Whether to also remove dashes from values when cleaning them. Defaults to TRUE.

data-mermaid/mermaidreporting documentation built on May 23, 2020, 7 a.m.