align_gg {ggalign} | R Documentation |
ggalign
is just an alias of align_gg
.
align_gg(
data = NULL,
mapping = aes(),
size = NULL,
free_labs = waiver(),
free_spaces = waiver(),
plot_data = waiver(),
limits = TRUE,
facet = TRUE,
set_context = TRUE,
order = NULL,
name = NULL
)
ggalign(
data = NULL,
mapping = aes(),
size = NULL,
free_labs = waiver(),
free_spaces = waiver(),
plot_data = waiver(),
limits = TRUE,
facet = TRUE,
set_context = TRUE,
order = NULL,
name = NULL
)
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
|
mapping |
Additional default list of aesthetic mappings to use for plot. |
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
|
A AlignGG
object.
align_gg
initializes a ggplot
data and mapping
.
The internal will always use a default mapping of aes(y = .data$.y)
or
aes(x = .data$.x)
.
For ggplot usage, matrix (including a simple vector) data is converted into a
long-format data frame. The data in the underlying ggplot
object will
contain following columns:
.panel
: the panel for current layout axis.
.x
or .y
: the x
or y
coordinates
.row_names
and .row_index
: A factor of the row names and an integer of
row index of the original matrix or data frame.
.column_names
and .column_index
: the column names and column index of
the original matrix (only applicable if data
is a matrix
).
value
: the actual matrix value (only applicable if data
is a
matrix
).
In the case where the input data is already a data frame, three additional
columns (.row_names
, .row_index
, and .panel
) are added to the data
frame.
if data is inherit from the heatmap layout, an additional column will be added.
.extra_panel
: the panel information for column (left or right
annotation) or row (top or bottom annotation).
ggheatmap(matrix(rnorm(81), nrow = 9)) +
hmanno("top") +
ggalign() +
geom_point(aes(y = value))