Skip to contents

Set consort diagram default options

Source: R/defaults.R
set_consort_defaults.Rd

Modify the default graphical parameters and other settings for consort diagrams. Any parameter set to NULL (the default) will remain unchanged. gpar arguments are merged with the current values, so only the properties to change need to be given. Use init_consort_defaults() to restore the package defaults, and get_consort_defaults() to view the current settings.

Usage

set_consort_defaults(
  arrow_gp = NULL,
  txt_gp = NULL,
  box_gp = NULL,
  label_txt_gp = NULL,
  label_box_gp = NULL,
  arrow_length = NULL,
  arrow_type = NULL,
  pad_u = NULL,
  bullet = NULL,
  parse_markup = NULL
)

get_consort_defaults()

init_consort_defaults()

# S3 method for class 'consort_defaults'
print(x, ...)

Arguments

arrow_gp

A gpar object for the arrow line (colour, line width, line type, etc.). Package default is gpar(col = "black", lwd = 1).

txt_gp

A gpar object for the text inside boxes (font size, colour, font family, etc.). Package default is gpar(cex = 1, col = "black").

box_gp

A gpar object for the box border and fill. Package default is gpar(fill = "white").

label_txt_gp

A gpar object for the label text. Package default is gpar(col = "#4F81BD", cex = 1, fontface = "bold").

label_box_gp

A gpar object for the label box. Package default is gpar(fill = "#A9C7FD").

arrow_length

Numeric, length of the arrowhead in inches. Default is 0.1.

arrow_type

Character, arrow type: "closed" (default) or "open".

pad_u

Numeric, padding between nodes in character units. Default is 3.

bullet

Character, bullet character for side box items, e.g. an en dash or a hyphen. Default is the Unicode bullet (U+2022).

parse_markup

Logical, whether to parse lightweight markup syntax (**bold**, *italic*, ^{superscript}, _{subscript}, __underline__) in node labels. Default is FALSE.

x

A consort_defaults object.

...

Not used.

Value

Invisibly returns the previous defaults (a consort_defaults object).

A consort_defaults object containing all current default settings.

Examples

# Change text color and box fill
old <- set_consort_defaults(
  txt_gp = grid::gpar(col = "navy", cex = 0.9),
  box_gp = grid::gpar(fill = "#F0F0F0")
)

# View current defaults
get_consort_defaults()
#> Consort diagram default settings:
#> 
#>   arrow_gp      : gpar(col = "blue", lwd = 2)
#>   txt_gp        : gpar(cex = 0.9, col = "navy")
#>   box_gp        : gpar(fill = "#F0F0F0")
#>   label_txt_gp  : gpar(col = "#4F81BD", cex = 1, font = "bold")
#>   label_box_gp  : gpar(fill = "#A9C7FD")
#>   arrow_length  : 0.1
#>   arrow_type    : "closed"
#>   pad_u         : 3
#>   bullet        : "○"
#>   parse_markup  : FALSE

# Restore previous defaults
set_consort_defaults(
  txt_gp = old$txt_gp,
  box_gp = old$box_gp
)
get_consort_defaults()
#> Consort diagram default settings:
#> 
#>   arrow_gp      : gpar(col = "blue", lwd = 2)
#>   txt_gp        : gpar(cex = 1, col = "black")
#>   box_gp        : gpar(fill = "white")
#>   label_txt_gp  : gpar(col = "#4F81BD", cex = 1, font = "bold")
#>   label_box_gp  : gpar(fill = "#A9C7FD")
#>   arrow_length  : 0.1
#>   arrow_type    : "closed"
#>   pad_u         : 3
#>   bullet        : "○"
#>   parse_markup  : FALSE