align {ggalign} | R Documentation |
Create a New CraftBox
Object with CraftAlign
craftsman
Description
An CraftAlign
object interacts with the Layout
object to reorder or split
observations and, in some cases, add plot components to the Layout
.
Usage
align(
align,
data = NULL,
...,
plot = NULL,
size = NULL,
schemes = NULL,
no_axes = NULL,
active = NULL,
call = caller_call()
)
Arguments
align |
An |
data |
The following options can be used:
|
... |
Additional fields passed to the |
plot |
A ggplot object. |
size |
The relative size of the plot, can be specified as a
|
schemes |
Options for
|
no_axes |
|
active |
A |
call |
The |
Details
Each of the Align*
objects is just a ggproto()
object, descended from the top-level CraftAlign
, and each implements
various methods and fields.
To create a new type of Align*
object, you typically will want to
override one or more of the following:
-
setup_params
: Prepare parameter or check parameters used by this plot. -
setup_data
: Prepare data used by this plot. -
compute
: A method used to compute statistics. -
align
: A method used to group observations into panel or reorder observations. -
draw
: A method used to draw the plot. Must return aggplot
object.
Value
A new CraftBox
object.
Discrete Axis Alignment
It is important to note that we consider rows as observations, meaning
vec_size(data)
/NROW(data)
must match the number of observations along the
axis used for alignment (x-axis for a vertical stack layout, y-axis for a
horizontal stack layout).
Examples
align_dendro()