uic_across: Perform UIC across data.frame
In ong8181/macam: A collection of miscellaneous R functions for ecology

uic_across

R Documentation

Perform UIC across data.frame

Description

uic_across Perform UIC for a target variable and multiple causal variables

Usage

uic_across(
  block,
  effect_var,
  E_range = 0:10,
  tp_range = -4:0,
  tau = 1,
  num_surr = 1000,
  alpha = 0.05,
  fdr = FALSE,
  silent = FALSE
)

Arguments

`block`	Data.frame contains time series data.
`effect_var`	Character or Numeric. Column name or index of the effect variable.
`E_range`	Numeric. Embedding dimensions that will be tested.
`tp_range`	Numeric. `tp` tested for UIC.
`tau`	Numeric. `tau` tested for UIC.
`num_surr`	Numeric. The number of surrogate data generated to compute p-value.
`alpha`	Numeric. the significant level to determine the embedding dimension of reference model (i.e., `E0`). If `alpha = NULL`, `E0` is set to `E - 1`. If `⁠0 < alpha < 1⁠` `E0` depends on the model results with lower embedding dimensions. Default is 0.05.
`fdr`	Logical. If `TRUE`, calculate False Discovery Rate using `stats::p.adjust()` and BH method.
`silent`	Logical. if `TRUE`, progress message will not be shown.