setup.figure: Method defining a layout scheme

In s-u/snippets: Code snippets, mostly visualization-related

Method defining a layout scheme

Description

Layout schemes are defined by the scheme object and the implmentation of the setup.figure method for that object.

The purpose of setup.figure is to set the "fig" graphical parameter according to the state represented by the scheme object. This allows implementation of arbitrary layout schemes.

Usage

setup.figure(scheme)
## S3 method for class 'gridColScheme'
setup.figure(scheme)
## S3 method for class 'gridRowScheme'
setup.figure(scheme)

Arguments

scheme

scheme defining the current state which is to be reflected in the graphics parameters

Details

The scheme will contain the enclosing figure region in scheme$fig and it is up to the setup.figure method implementation to use the advancement index scheme$index to determine the appropriate region to set the "fig" graphics parameter. Clearly, the scheme object can contain any additonal necessary needed for the method to perform its function.

For example, the grid layout schemes keep the matrix of the grid in the scheme object and use simple modulo operation to determine the approriate column and row to set "fig" accordingly.

Value

scheme

Author(s)

Simon Urbanek

s-u/snippets documentation built on June 29, 2022, 6:42 a.m.