align {ggalign} | R Documentation |
Align
objectAlign
object will act with the layout
object, reorder or split the
observations, some of them can also add plot components into the layout
object.
align(
align_class,
params,
data,
size = NULL,
free_labs = waiver(),
free_spaces = waiver(),
plot_data = waiver(),
limits = TRUE,
facet = TRUE,
set_context = TRUE,
order = NULL,
name = NULL,
check.param = TRUE,
call = caller_call()
)
data |
A matrix, a data frame, or even a simple vector that will be
converted into a one-column matrix. If the It is important to note that all
|
size |
Plot size, can be an unit object. |
free_labs |
A boolean value or a string containing one or more of
|
free_spaces |
A character specifies the ggplot elements which won't
count space sizes when alignment. If |
plot_data |
A function used to transform the plot data before rendering.
By default, it'll inherit from the parent layout. If no parent layout, the
default is to not modify the data. Use Used to modify the data after layout has been created, but before the data is
handled of to the ggplot2 for rendering. Use this hook if the you needs
change the default data for all |
limits |
A boolean value indicates whether to set the layout limtis for the plot. |
facet |
A boolean value indicates whether to set the layout facet for
the plot. If this is |
set_context |
A single boolean value indicates whether to set the active
context to current plot. If |
order |
An single integer for the layout order. |
name |
A string of the plot name. Used to switch the active context in
|
check.param |
A single boolean value indicates whether to check the supplied parameters and warn. |
call |
The |
A new Align
object.
Each of the Align*
objects is just a ggproto() object,
descended from the top-level Align
, 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
annotation.
setup_data
: Prepare data used by this annotation.
compute
: A method used to compute statistics.
layout
: A method used to group heamap rows/columns into panel or
reorder heamtap rows/columns.
draw
: A method used to draw the plot. Must return a ggplot
object.
align_gg()
align_dendro()