Skip to contents

Adds a figure specification at runtime so it can be used by available_fig_specs(), panel_size(), and get_fig_size_cm().

Usage

register_fig_spec(
  name,
  panel_w_cm,
  panel_h_cm,
  nonpanel_w_cm = 0.9,
  nonpanel_h_cm = 0.9,
  gap_cm = 0.15,
  base_font_pt = 7,
  min_linewidth = 0.35,
  alias = NULL,
  layout_hint = NULL,
  overwrite = FALSE
)

Arguments

name

Specification name.

panel_w_cm

Panel width in centimeters.

panel_h_cm

Panel height in centimeters.

nonpanel_w_cm

Reserved horizontal non-panel space in centimeters.

nonpanel_h_cm

Reserved vertical non-panel space in centimeters.

gap_cm

Gap between panels in centimeters.

base_font_pt

Recommended base font size in points.

min_linewidth

Recommended minimum line width.

alias

Optional compatibility aliases that should resolve to name.

layout_hint

Optional hint text returned by panel_size().

overwrite

Whether to overwrite an existing registered specification.

Value

The registered figure specification row, invisibly.