Visualise alpha diversity significance results
Source:R/alpha_significance.R
plot_alpha_significance.RdSummarises the pairwise significance table from compute_alpha_significance()
either as a filtered tibble (type = "table") or a Cohen's d heatmap with
significance annotations (type = "heatmap").
Usage
plot_alpha_significance(
x,
metric = NULL,
rank = NULL,
type = c("table", "heatmap"),
p_threshold = 0.05,
...
)Arguments
- x
A
"phip_alpha_significance"object fromcompute_alpha_significance().- metric
Character scalar; metric to display. Defaults to the first metric present in
x.- rank
Character scalar; rank to display. Defaults to the first rank present in
x. Ignored when the data has norankcolumn.- type
One of
"table"(default) or"heatmap".- p_threshold
Numeric; pairs with
p_adj > p_thresholdare shown in grey in the heatmap and excluded from the table. Default0.05.- ...
Reserved; ignored.
Value
type = "table": atibble::tibbleof significant pairwise results.type = "heatmap": aggplotheatmap (Cohen's d fill, stars overlaid).
Examples
if (FALSE) { # \dontrun{
sig <- compute_alpha_significance(alpha_list)
plot_alpha_significance(sig, type = "table")
plot_alpha_significance(sig, type = "heatmap")
} # }