transform_mod_results

Applies a transformation to the effect sizes and their confidence/prediction intervals from a model result object returned by <code>mod_results</code>.

internal

Generates prediction intervals and orchard plots for
meta-analytic and meta-regression models fitted with the 'metafor'
package. Orchard plots augment classic forest plots by displaying
individual effect sizes together with group means and their confidence
and prediction intervals, providing an enhanced visualization of
meta-analytic data for ecology, evolution, and beyond. Methods are
described in Nakagawa et al. (2023) <doi:10.1111/2041-210X.14152>.

Daniel Noble

orchaRd

Visualizing Meta-Analyses with Orchard Plots and Prediction
Intervals

Shinichi Nakagawa

transform_mod_results function

<dl><dt>results</dt>
<dd>An object of class <code>orchard</code>, the output from <code>mod_results</code>.</dd>
<dt>transfm</dt>
<dd>A character string specifying the transformation to apply. Options include:
- <code>"none"</code>: No transformation (default)
- <code>"tanh"</code>: Hyperbolic tangent transformation
- <code>"invlogit"</code>: Inverse logit transformation
- <code>"percentr"</code>: Percentage relative change transformation
- <code>"percent"</code>: Percentage transformation
- <code>"inv_ft"</code>: Inverse Freeman-Tukey (double arcsine) transformation for proportions (use with caution)</dd>
<dt>n_transfm</dt>
<dd>A numeric vector of sample sizes, used only when <code>transfm = "inv_ft"</code>. Defaults to <code>NULL</code>.</dd></dl>

Arguments

Transform effect sizes in an orchard object — transform_mod_results

<dl>

<dt>results</dt>
<dd>An object of class <code>orchard</code>, the output from <code>mod_results</code>.</dd>


<dt>transfm</dt>
<dd>A character string specifying the transformation to apply. Options include:
- <code>"none"</code>: No transformation (default)
- <code>"tanh"</code>: Hyperbolic tangent transformation
- <code>"invlogit"</code>: Inverse logit transformation
- <code>"percentr"</code>: Percentage relative change transformation
- <code>"percent"</code>: Percentage transformation
- <code>"inv_ft"</code>: Inverse Freeman-Tukey (double arcsine) transformation for proportions (use with caution)</dd>


<dt>n_transfm</dt>
<dd>A numeric vector of sample sizes, used only when <code>transfm = "inv_ft"</code>. Defaults to <code>NULL</code>.</dd>

</dl>

transform_mod_results: Transform effect sizes in an orchard object

Description

Usage

Value

Arguments