Set parameters for the barplots.

Usage

plotsettings_tablebarplot(
  axis_x_label_size = NULL,
  axis_x_lims = NULL,
  background_stripes_border = NULL,
  background_stripes_colour = NULL,
  bar_background_lines = NULL,
  bar_background_lines_linetype = NULL,
  bar_background_lines_spanners = NULL,
  bar_fill_colour = NULL,
  bar_frame_linetype = NULL,
  bar_label_nudge_x = NULL,
  bar_label_size = NULL,
  bar_line_width = NULL,
  bar_nudge_y = NULL,
  bar_pattern_fill_colour = NULL,
  bar_pattern_spacing = NULL,
  bar_pattern_type = NULL,
  bar_pattern_width = NULL,
  bar_sig_type = NULL,
  bar_width = NULL,
  column_spanners_nudge_y = NULL,
  column_spanners_row_height = NULL,
  column_spanners_2_nudge_y = NULL,
  column_spanners_2_row_height = NULL,
  columns_alignment = NULL,
  columns_nudge_x = NULL,
  columns_nudge_y = NULL,
  columns_table_sig_high_letter = NULL,
  columns_table_sig_high_letter_nudge_x = NULL,
  columns_width = NULL,
  headers_alignment = NULL,
  headers_background_colour = NULL,
  headers_font_size = NULL,
  headers_nudge_x = NULL,
  headers_nudge_y = NULL,
  headers_row_height = NULL,
  font_size = NULL,
  space_right = NULL,
  default_list = NULL
)

Arguments

axis_x_label_size: Numeric for the size of the x axis labels. Defaults to 5.
axis_x_lims: Numeric vector of length 2 for the x-axis limits. Will be set automatically, NULL (default).
background_stripes_border: Character string of either c("Inf", "background_line_both", "background_line_left", "background_line_right"). The background stripes will either be drawn over the whole plot ("Inf"), from the outer left background_line to the outer right background_line ("background_line_both"), from the outer left background line to the right of the plot ("background_line_left"), or the outer right background line to the left of the plot ("background_line_right).
background_stripes_colour: Named vector containing the two colours that should be used for the striped background. Defaults to NULL.
bar_background_lines: Character string of either c("borders", "scale_breaks", "none"), indicating whether the barplot should receive dotted lines on its borders, at every scale break or none at all.
bar_background_lines_linetype: Character string indicating the linetype for the background lines of the barplot.
bar_background_lines_spanners: List containing of numeric vectors of two elements for indicating over which rows the background_lines in the barplot should span. Each vector contains the start and end row for the background line. Defaults to NULL, in which case The background_lines will be drawn from top to bottom.
bar_fill_colour: Colour of the bar filling. Can be either one colour for all bars, or a (named) vector with the names of the groups specified in bar_fill. If no names are provided for the vector, the order of the factor levels of bar_fill will be used for determining the colour assignment.
bar_frame_linetype: Named vector with the bar frame linetypes. Names have to be found in the column defined in the bar_sig-argument ofplot_tablebar(). Defaults to solid.
bar_label_nudge_x: Numeric for nudging the bar labels in x direction.
bar_label_size: Numeric for the font size of the bar labels.
bar_line_width: Numeric for the line-size around the bar.
bar_nudge_y: Numeric for nudging the bar in y direction. Defaults to 0.
bar_pattern_fill_colour: Named vector with the filling colours for the bar pattern. Names of the vector must be found in the column specified in bar_pattern_fill. Defaults to white.
bar_pattern_spacing: Numeric for the gap between patterns.
bar_pattern_type: Named vector with the pattern types for the barpattern.
bar_pattern_width: Numeric for the width of the pattern stripes. Note that by default the pattern are the whit stripes, so an increase of the bar_pattern_width parameter will increase the thickness of the white stripes.
bar_sig_type: Character string indicating whether levels of the grouping variable should be visualized by pattern fill ("pattern") or line type ("frame").
bar_width: Numeric between 0 and 1 specifying the width of the bar. Defaults to 0.4.
column_spanners_nudge_y: Numeric vector to increase or decrease the space between column spanners text and line. Can be either of length 1, or provide a nudging parameter for each column spanner. Defaults to -0.2.
column_spanners_row_height: Numeric for the row height of the row the first level of column spanners is written in. Defaults to 1.
column_spanners_2_nudge_y: Numeric vector to increase or decrease the space between column spanners level 2 text and line. Can be either of length 1, or provide a nudging parameter for each column spanner. Defaults to -0.2.
column_spanners_2_row_height: Numeric for the row height of the row the second level of column spanners is written in. Defaults to 1
columns_alignment: Numeric vector with one element for each column, determining the text adjustement within the column. Can be 0 (left-aligned), 0.5 (central-aligned), or 1 (right-aligned). Defaults to 0.5.
columns_nudge_x: Numeric vector to nudge the column text in x direction. Defaults to 0.
columns_nudge_y: Numeric vector to nudge the column texts in y direction. Defaults to 0.
columns_table_sig_high_letter: Character, that will be added on significant values defined by columns_table_sig_high.
columns_table_sig_high_letter_nudge_x: Numeric for nudging the superscript towards or away from a number.
columns_width: Numeric vector with relative column widths. Has to be equal to the number of columns (including the bar chart, if a bar chart is plotted) that are plotted in the table. Defaults to NULL, in which case all collumns will get the same width.
headers_alignment: Numeric vector with one element for each column, determining the text adjustement of the headers. Can be 0 (left-aligned), 0.5 (central-aligned), or 1 (right-aligned). Defaults to NULL, in which case the alignment of the columns will be adopted.
headers_background_colour: Colour of the background of the headers.
headers_font_size: Numeric for the font size that will be used for the headers and column_spanners. Defaults to 3.
headers_nudge_x: Numeric to nudge the column_headers in x direction. Defaults to 0.
headers_nudge_y: Numeric to nudge the column_headers in y direction. Defaults to 0.
headers_row_height: Numeric for the row height of the row the headers are written in. Defaults to 1.
font_size: Numeric vector with as many elements as columns for the font sizes of the columns. Defaults to 3.
space_right: Numeric for the width of a white space that will be added on the right of the plotting pane. Has to be the same scale as the data. Defaults to 0.
default_list: Named list with predefined settings. Defaults to a list with all settings set to 0.

Value

A named list with settings for a table/barplot.

Examples

## Calling the function without any arguments will result in the default settings-list.
plotsettings_tablebarplot()
#> $axis_x_label_size
#> [1] 5
#> 
#> $axis_x_lims
#> NULL
#> 
#> $background_stripes_border
#> [1] "Inf"
#> 
#> $background_stripes_colour
#> [1] "white"
#> 
#> $bar_background_lines
#> [1] "none"
#> 
#> $bar_background_lines_linetype
#> [1] "solid"
#> 
#> $bar_background_lines_spanners
#> NULL
#> 
#> $bar_fill_colour
#> [1] "white"
#> 
#> $bar_frame_linetype
#> [1] "solid"
#> 
#> $bar_label_size
#> [1] 2
#> 
#> $bar_label_nudge_x
#> [1] 0
#> 
#> $bar_line_width
#> [1] 0.5
#> 
#> $bar_nudge_y
#> [1] 0
#> 
#> $bar_pattern_fill_colour
#> [1] "white"
#> 
#> $bar_pattern_type
#> [1] "none"
#> 
#> $bar_sig_type
#> [1] "frame"
#> 
#> $bar_width
#> [1] 0.4
#> 
#> $column_spanners_nudge_y
#> [1] -0.2
#> 
#> $column_spanners_row_height
#> [1] 1
#> 
#> $column_spanners_2_nudge_y
#> [1] -0.2
#> 
#> $column_spanners_2_row_height
#> [1] 1
#> 
#> $columns_alignment
#> [1] 0.5
#> 
#> $columns_nudge_x
#> [1] 0
#> 
#> $columns_nudge_y
#> [1] 0
#> 
#> $columns_table_sig_high_letter
#> [1] "a"
#> 
#> $columns_table_sig_high_letter_nudge_x
#> [1] 0
#> 
#> $columns_width
#> NULL
#> 
#> $headers_alignment
#> NULL
#> 
#> $headers_background_colour
#> [1] "white"
#> 
#> $headers_font_size
#> [1] 2
#> 
#> $headers_nudge_x
#> [1] 0
#> 
#> $headers_nudge_y
#> [1] 0
#> 
#> $headers_row_height
#> [1] 1
#> 
#> $bar_pattern_spacing
#> [1] 0.1
#> 
#> $bar_pattern_width
#> [1] 0.5
#> 
#> $font_size
#> [1] 3
#> 
#> $space_right
#> [1] 0
#> 

## Arguments will overvrite the respective list element:
plot_settings <- plotsettings_tablebarplot(font_size = 2.5)
plot_settings$font_size
#> [1] 2.5

## Colours can be defined like so:
plotsettings_tablebarplot(
  bar_fill_colour = c(
    "blue",
    grDevices::rgb(10, 13, 82, maxColorValue = 255)
  )
)
#> $axis_x_label_size
#> [1] 5
#> 
#> $axis_x_lims
#> NULL
#> 
#> $background_stripes_border
#> [1] "Inf"
#> 
#> $background_stripes_colour
#> [1] "white"
#> 
#> $bar_background_lines
#> [1] "none"
#> 
#> $bar_background_lines_linetype
#> [1] "solid"
#> 
#> $bar_background_lines_spanners
#> NULL
#> 
#> $bar_fill_colour
#> [1] "blue"    "#0A0D52"
#> 
#> $bar_frame_linetype
#> [1] "solid"
#> 
#> $bar_label_size
#> [1] 2
#> 
#> $bar_label_nudge_x
#> [1] 0
#> 
#> $bar_line_width
#> [1] 0.5
#> 
#> $bar_nudge_y
#> [1] 0
#> 
#> $bar_pattern_fill_colour
#> [1] "white"
#> 
#> $bar_pattern_type
#> [1] "none"
#> 
#> $bar_sig_type
#> [1] "frame"
#> 
#> $bar_width
#> [1] 0.4
#> 
#> $column_spanners_nudge_y
#> [1] -0.2
#> 
#> $column_spanners_row_height
#> [1] 1
#> 
#> $column_spanners_2_nudge_y
#> [1] -0.2
#> 
#> $column_spanners_2_row_height
#> [1] 1
#> 
#> $columns_alignment
#> [1] 0.5
#> 
#> $columns_nudge_x
#> [1] 0
#> 
#> $columns_nudge_y
#> [1] 0
#> 
#> $columns_table_sig_high_letter
#> [1] "a"
#> 
#> $columns_table_sig_high_letter_nudge_x
#> [1] 0
#> 
#> $columns_width
#> NULL
#> 
#> $headers_alignment
#> NULL
#> 
#> $headers_background_colour
#> [1] "white"
#> 
#> $headers_font_size
#> [1] 2
#> 
#> $headers_nudge_x
#> [1] 0
#> 
#> $headers_nudge_y
#> [1] 0
#> 
#> $headers_row_height
#> [1] 1
#> 
#> $bar_pattern_spacing
#> [1] 0.1
#> 
#> $bar_pattern_width
#> [1] 0.5
#> 
#> $font_size
#> [1] 3
#> 
#> $space_right
#> [1] 0
#> 

## Or, to get better control over the colour assignment
## we can also directly name the colours with the different groups
## defined in the bar_sig-argument of plot_tablebar()
## (as these groups are used to distinguish between different bar colours):
plotsettings_tablebarplot(
  bar_fill_colour = c(
    fill_group_1 = "blue",
    fill_group_2 = grDevices::rgb(
      10, 13, 82,
      maxColorValue = 255
    )
  )
)
#> $axis_x_label_size
#> [1] 5
#> 
#> $axis_x_lims
#> NULL
#> 
#> $background_stripes_border
#> [1] "Inf"
#> 
#> $background_stripes_colour
#> [1] "white"
#> 
#> $bar_background_lines
#> [1] "none"
#> 
#> $bar_background_lines_linetype
#> [1] "solid"
#> 
#> $bar_background_lines_spanners
#> NULL
#> 
#> $bar_fill_colour
#> fill_group_1 fill_group_2 
#>       "blue"    "#0A0D52" 
#> 
#> $bar_frame_linetype
#> [1] "solid"
#> 
#> $bar_label_size
#> [1] 2
#> 
#> $bar_label_nudge_x
#> [1] 0
#> 
#> $bar_line_width
#> [1] 0.5
#> 
#> $bar_nudge_y
#> [1] 0
#> 
#> $bar_pattern_fill_colour
#> [1] "white"
#> 
#> $bar_pattern_type
#> [1] "none"
#> 
#> $bar_sig_type
#> [1] "frame"
#> 
#> $bar_width
#> [1] 0.4
#> 
#> $column_spanners_nudge_y
#> [1] -0.2
#> 
#> $column_spanners_row_height
#> [1] 1
#> 
#> $column_spanners_2_nudge_y
#> [1] -0.2
#> 
#> $column_spanners_2_row_height
#> [1] 1
#> 
#> $columns_alignment
#> [1] 0.5
#> 
#> $columns_nudge_x
#> [1] 0
#> 
#> $columns_nudge_y
#> [1] 0
#> 
#> $columns_table_sig_high_letter
#> [1] "a"
#> 
#> $columns_table_sig_high_letter_nudge_x
#> [1] 0
#> 
#> $columns_width
#> NULL
#> 
#> $headers_alignment
#> NULL
#> 
#> $headers_background_colour
#> [1] "white"
#> 
#> $headers_font_size
#> [1] 2
#> 
#> $headers_nudge_x
#> [1] 0
#> 
#> $headers_nudge_y
#> [1] 0
#> 
#> $headers_row_height
#> [1] 1
#> 
#> $bar_pattern_spacing
#> [1] 0.1
#> 
#> $bar_pattern_width
#> [1] 0.5
#> 
#> $font_size
#> [1] 3
#> 
#> $space_right
#> [1] 0
#>