smallsets (version 2.0.0)

sets_spacing: Sets spacing

Description

Sets spacing parameters for the Smallset Timeline.

Usage

sets_spacing(
  captions = NULL,
  degree = NULL,
  header = NULL,
  right = NULL,
  rows = NULL,
  columns = NULL
)

Value

Returns a list with six elements (the spacing parameters).

Arguments

captions

Positive numeric value for amount of caption space. When alignment is horizontal, refers to the space below snapshots. When alignment is vertical, refers to the space to the right of the snapshots. Default is 2.5.

degree

Integer between 0-90 (degrees) to rotate column names. Default is 0.

header

Positive numeric value for amount of column name space. Default is 1.

right

Positive numeric value (>=.5) for amount of space to the right of each snapshot.

rows

Integer for number of Smallset Timeline rows (applicable when the alignment is horizontal). Default is 1.

columns

Integer for number of Smallset Timeline columns (applicable when the alignment is vertical). Default is 1.

Details

Passed to spacing in Smallset_Timeline.

Examples

# increase space for captions and rotate column names
Smallset_Timeline(
   data = s_data,
   code = system.file("s_data_preprocess.R", package = "smallsets"),
   spacing = sets_spacing(captions = 5, degree = 45)
)