Filter Correlation Results — filter_correlation • microbiomedataset

Keep only correlation edges that pass user-defined score and significance thresholds.

Usage

filter_correlation(
  object,
  min_abs_correlation = 0,
  max_q_value = 1,
  direction = c("any", "positive", "negative")
)

Arguments

object: A microbe_metabolite_association object.
min_abs_correlation: Minimum absolute correlation estimate.
max_q_value: Maximum q value.
direction: Direction of correlation to keep.

Value

A microbe_metabolite_association object.

Examples

data("demo_crossomics", package = "microbiomedataset")

x <- calculate_correlation(
  microbiome_data = demo_crossomics$microbiome_data,
  metabolome_data = demo_crossomics$metabolome_data,
  sample_link = demo_crossomics$sample_link,
  metabolome_transform = "none"
)
y <- filter_correlation(x, min_abs_correlation = 0.3, max_q_value = 0.2)
y
#> microbe_metabolite_association
#> Method: spearman
#> Microbiome rank: Genus
#> Rows: 0