Set Style — set_style • cqtkit

Creates a style list for eda graphing functions.

Usage

set_style(
  style = NULL,
  title = NULL,
  xlabel = NULL,
  ylabel = NULL,
  xlims = NULL,
  ylims = NULL,
  colors = NULL,
  labels = NULL,
  shapes = NULL,
  legend = NULL,
  shape_legend = NULL,
  color_order = NULL,
  shape_order = NULL,
  linetype_order = NULL,
  legend.position = NULL,
  legend.title.position = NULL,
  legend.title.hjust = NULL,
  logx = NULL,
  logy = NULL,
  fill_alpha = NULL,
  fill_legend = NULL,
  fill_order = NULL,
  caption_hjust = NULL,
  legend_nrow = NULL
)

Arguments

style: An optional named list of style arguments to update
title: A string for a plot title
xlabel: A string for x-axis label
ylabel: A string for y-axis label
xlims: A tuple of numbers specifying limits for x-axis
ylims: A tuple of numbers specifying limits for y-axis
colors: A named character vector for setting colors
labels: A named character vector for setting legend labels
shapes: A named character vector for setting geom_point shapes
legend: A string for setting color legend title
shape_legend: A string for setting shape legend title
color_order: A numeric for setting color legend order
shape_order: A numeric for setting shape legend order
linetype_order: A numeric for setting linetype legend order
legend.position: A string for legend position
legend.title.position: A string for legend title position ("top", "left", "bottom", "right")
legend.title.hjust: A string or numeric for legend title horizontal justification ("left"/0, "center"/0.5, "right"/1)
logx: Logical, whether to use log scale for x-axis
logy: Logical, whether to use log scale for y-axis
fill_alpha: A numeric for controlling alpha of fill colors
fill_legend: A string to replace fill legend title
fill_order: A numeric for setting fill legend order
caption_hjust: A string or numeric for caption horizontal justification ("left"/0, "center"/0.5, "right"/1)
legend_nrow: A numeric for number of rows in legend

Value

A named list of style parameters for use with style_plot()

Examples

data_proc <- cqtkit_data_verapamil |> preprocess()
style = set_style(
  colors = c(
    "0 mg Placebo" = "grey"
  ),
  labels = c(
    "Reference -10" = NA,
    "Reference 10" = "+/- 10 ms dQTcF",
    "0 mg Placebo" = "Placebo",
    "120 mg Verapamil" = "Verapamil"
  ),
  legend = "Treatment"
)
style
#> $title
#> NULL
#> 
#> $xlabel
#> NULL
#> 
#> $ylabel
#> NULL
#> 
#> $xlims
#> NULL
#> 
#> $ylims
#> NULL
#> 
#> $colors
#> 0 mg Placebo 
#>       "grey" 
#> 
#> $labels
#>     Reference -10      Reference 10      0 mg Placebo  120 mg Verapamil 
#>                NA "+/- 10 ms dQTcF"         "Placebo"       "Verapamil" 
#> 
#> $shapes
#> NULL
#> 
#> $legend
#> [1] "Treatment"
#> 
#> $shape_legend
#> NULL
#> 
#> $color_order
#> NULL
#> 
#> $shape_order
#> NULL
#> 
#> $linetype_order
#> NULL
#> 
#> $legend.position
#> NULL
#> 
#> $legend.title.position
#> [1] "top"
#> 
#> $legend.title.hjust
#> NULL
#> 
#> $logx
#> NULL
#> 
#> $logy
#> NULL
#> 
#> $fill_alpha
#> NULL
#> 
#> $fill_legend
#> NULL
#> 
#> $fill_order
#> NULL
#> 
#> $caption_hjust
#> NULL
#> 
#> $legend_nrow
#> NULL
#>