Package index • ggalign

Layout

A Layout object defines how to place the plots.

layout_heatmap() ggheatmap(): Arrange plots around a Heatmap

layout_stack() ggstack(): Put plots horizontally or vertically

Layout Building

All plots begin with a call to ggheatmap() or ggstack(), supplying default data. You then reorder the layout, or group the layout into panels, and add plots, layers, scales, coords with +. Use hmanno() or stack_active() to control the layout attributes. To save a plot to disk, use ggsave().

`+`(<Layout>,<ANY>): Add components to Layout

hmanno(): Determine the active context of heatmap layout

stack_active(): Determine the active context of stack layout

`&`(<Layout>,<ANY>) `-`(<Layout>,<ANY>): Layout operator

Layout Plot

This section covers essential functions to add individual plots to the layout, ensuring they align and interact correctly within the defined structure.

align_gg() ggalign(): Create ggplot object with a customized data

align_panel() ggpanel(): Create ggplot object with layout panel data

Layout Customization

Fine-tune the arrangement of plots by reordering or splitting axes into separate panels. These functions allow for more detailed customization of plot layouts.

align_dendro(): Reorder or Group layout based on hierarchical clustering

align_group(): Group and align layout based on categorical or factor levels.

align_kmeans(): Split layout by k-means clustering groups.

align_reorder(): Reorders layout observations based on weights or summary statistics.

Plot composer

This section outlines essential functions for composing plots into a grid, intended for internal use. The core code is derived from the patchwork package, with the hope of eventually integrating and merging these functions into the patchwork project.

align_plots(): Arrange multiple plots into a grid

patch_titles(): Add patch titles to plot borders

free_align() free_border() free_lab() free_space() free_vp(): Free from alignment

area(): Define the plotting areas in align_plots

inset(): Create a ggplot inset

wrap(): Wrap Arbitrary Graphics for Alignment

Extending Plot Composer

Extending capabilities to align graphics with align_plots().

alignpatch(): Prepare plots to be aligned with align_plots

patch(): Convert Object into a Grob

helpers

A handful of helpers

ggalignGrob(): Generate a plot grob.

ggalign_stat(): Get the statistics from the layout

hclust2(): Generate Tree Structures with Hierarchical Clustering

dendrogram_data(): Dengrogram x and y coordinates

is.ggheatmap(): Reports whether x is a HeatmapLayout object

is.ggstack(): Reports whether x is a StackLayout object

geom_draw(): Layer with Grid or Function

read_example(): Read Example Data