grob_layout {grobblR}

Grob Layout

Description

The main grobblR function which contains and organizes grob_col's and grob_row's, giving the overall grob-layout its shape.

Usage

grob_layout(
  ...,
  height = 280,
  width = 216,
  title = "",
  title_aes_list = ga_list(),
  title_p = 0.1,
  title_height = NA_real_,
  caption = "",
  caption_aes_list = ga_list(),
  caption_p = 0.05,
  caption_height = NA_real_,
  padding_p = 0.05,
  padding = NA_real_,
  page_number = ""
)

Arguments

...

The combination of grob-rows and grob-columns which will help give the main grob-layout outputted its structure and aesthetics.

height

The numeric height of the grob-layout in millimeters.

Default is 280 mm - which is the height of an upright 8.5 x 11 inches piece of copy paper.

width

The numeric width of the grob in millimeters.

Default is 216 mm - which is the width of an upright 8.5 x 11 inches piece of copy paper.

title

A character string which will be displayed as the title of the grob-layout.

title_aes_list

The list outputted by ga_list, which controls aesthetics of the title of the grob-layout.

title_p

The numeric proportion the grob-layout's height will be used by the title grob.

title_height

The numeric height in mm within the grob-layout which will be used by the title grob. Will override title_p if provided.

caption

A character string which will be displayed as the caption at the bottom of the grob-layout.

caption_aes_list

The list outputted by ga_list, which controls aesthetics of the caption of the grob-layout.

caption_p

The numeric proportion of height within the grob-layout and its allotted space which will be used by the caption grob.

caption_height

The numeric height in mm within the grob-layout which will be used by the caption grob. Will override caption_p if provided.

padding_p

The proportion of the minimum of the height and width which will be used for the padding around the edge of the grob-layout.

Overridden by any numeric value provided in the padding parameter.

padding

The numeric amount of padding around the edge of the grob-layout in millimeters.

page_number

A single value that can be converted to an integer for the page number in the bottom right of the grob-layout within its padding. If it cannot be converted to an integer, the page number will not appear.

Details

Learn more in vignette("grob_layout")

Value

An R6 class object containing all information necessary to create the overall grob-layout.

Examples

grob_layout(
  grob_row(grob_col(1, border = TRUE), grob_col(2, border = TRUE)),
  grob_row(grob_col(3, border = TRUE))
  ) %>%
  view_grob(100, 100)