plot_data

<a href="https://lifecycle.r-lib.org/articles/stages.html#experimental"><img src="figures/lifecycle-experimental.svg?package=ggalign&version=0.0.5" alt="[Experimental]"></a>
Transforms the plot data. Many functions in this package require a specific
data format to align observations, <code>plot_data()</code> helps reformat data frames
as needed.

A 'ggplot2' extension offers various tools for organizing and arranging plots.
It is designed to consistently align a specific axis across multiple 'ggplot' objects,
making it especially useful for plots requiring data order manipulation. A typical use
case includes organizing combinations like a dendrogram and a heatmap.

Yun Peng

ggalign

A 'ggplot2' Extension for Consistent Axis Alignment

plot_data function

<dl><dt>data</dt>
<dd>A function to transform the plot data before rendering, referred
to as <code>plot_data</code>. Acceptable values include:<ul>
<li><code>NULL</code>: No action taken.</li>
<li><code><a href="https://ggplot2.tidyverse.org/reference/waiver.html">waiver()</a></code>: Inherits from the parent layout.</li>
<li>A <code>function</code> or purrr-style <code>formula</code>: Used to transform the plot data,
which should accept a data frame and return a data frame. You can apply
this after the parent layout <code>plot_data</code> function, using the <code>inherit</code>
argument.</li>
</ul></dd>Use this hook to modify the data for all <code>geoms</code> after the layout is created
(for matrix data, it has been melted to a long format data frame) but before
rendering by <code>ggplot2</code>. The returned data must be a data frame for ggplot.
<dt>inherit</dt>
<dd>A single boolean value indicates whether to apply the parent
<code>plot_data</code> first and then apply the specified <code>plot_data</code> for the plot.
Defaults to <code>FALSE</code>.</dd></dl>

Arguments

<a href='https://lifecycle.r-lib.org/articles/stages.html#experimental'><img src='figures/lifecycle-experimental.svg' alt='[Experimental]' /></a>
Transforms the plot data. Many functions in this package require a specific
data format to align observations, <code>plot_data()</code> helps reformat data frames
as needed.

Plot data Specifications — plot_data

<dl>

<dt>data</dt>
<dd>A function to transform the plot data before rendering, referred
to as <code>plot_data</code>. Acceptable values include:<ul>
<li><code>NULL</code>: No action taken.</li>
<li><code><a href='https://ggplot2.tidyverse.org/reference/waiver.html'>waiver()</a></code>: Inherits from the parent layout.</li>
<li>A <code>function</code> or purrr-style <code>formula</code>: Used to transform the plot data,
which should accept a data frame and return a data frame. You can apply
this after the parent layout <code>plot_data</code> function, using the <code>inherit</code>
argument.</li>
</ul>

Use this hook to modify the data for all <code>geoms</code> after the layout is created
(for matrix data, it has been melted to a long format data frame) but before
rendering by <code>ggplot2</code>. The returned data must be a data frame for ggplot.</dd>


<dt>inherit</dt>
<dd>A single boolean value indicates whether to apply the parent
<code>plot_data</code> first and then apply the specified <code>plot_data</code> for the plot.
Defaults to <code>FALSE</code>.</dd>

</dl>

plot_data: Plot data Specifications

Description

Usage

Arguments

Details