null_model_distribution_stats: Compare a value to random values

View source: R/tad.R

null_model_distribution_statsR Documentation

Compare a value to random values

Description

Compute different statistics (standardized by the distribution of random values).

Usage

null_model_distribution_stats(
  observed_value,
  random_values,
  significance_threshold = c(0.05, 0.95),
  remove_nas = TRUE
)

Arguments

observed_value

the observed value

random_values

the random Values

significance_threshold

the array of values used to compute the quantile (c(0.025, 0.975) by default)

remove_nas

boolean - tells weither to remoe NAs or not

Value

a list corresponding to :

  • the observed value

  • quantile values (minimum significance threshold)

  • quantile values (maximum significance threshold)

  • significance (observed value not in quantile values)

Examples


null_model_distribution_stats(
  observed_value = 2,
  random_values = c(1, 4, 5, 6, 8),
  significance_threshold = c(0.025, 0.975)
)


TAD documentation built on April 4, 2025, 5:10 a.m.