Skip to contents

Determine the Active Context of Quad-Layout

Source: R/layout-quad-switch.R
quad_active.Rd

[Stable]

  • quad_active: Sets the active context to the quad_layout()/ggheatmap() itself.

  • quad_anno: Sets the active context to the specified annotation stack based on the position argument.

  • anno_top: A special case of quad_anno with position = "top".

  • anno_left: A special case of quad_anno with position = "left".

  • anno_bottom: A special case of quad_anno with position = "bottom".

  • anno_right: A special case of quad_anno with position = "right".

Usage

quad_active(width = NULL, height = NULL)

quad_anno(position, size = NULL, free_guides = waiver(), what = waiver())

anno_top(size = NULL, free_guides = waiver(), what = waiver())

anno_left(size = NULL, free_guides = waiver(), what = waiver())

anno_bottom(size = NULL, free_guides = waiver(), what = waiver())

anno_right(size = NULL, free_guides = waiver(), what = waiver())

Arguments

width, height

The relative width/height of the main plot, can be a unit object.

position

A string of "top", "left", "bottom", or "right" indicates which annotation stack should be activated.

size

A numeric value or an unit object to set the total height/width of the annotation stack.

  • If position is "top" or "bottom", size sets the total height of the annotation.

  • If position is "left" or "right", size sets the total width of the annotation.

free_guides

Override the guides collection behavior specified in the quad_layout()/ggheatmap() for the annotation stack.

what

What should get activated in the annotation stack? A single number or string of the plot elements in the stack layout. If NULL, will remove any active context.

Value

An object that can be added to quad_layout()/ggheatmap().

Details

By default, quad_anno() will try to initialize the annotation stack layout using data from quad_layout()/ggheatmap(). However, there are situations where the annotation stack cannot be initialized due to incompatible data formats between quad_layout() and the required format for the annotation stack. This often occurs in quad_alignh() and quad_alignv(), where the layout data is a matrix, but top and bottom annotations (in quad_alignh()) or left and right annotations (in quad_alignv()) require a data frame. In such cases, you must use quad_init() to manually initialize the annotation stack.

See also