make_block_mvd: Generate block for MDR S-map
In ong8181/macam: A collection of miscellaneous R functions for ecology

make_block_mvd

R Documentation

Generate block for MDR S-map

Description

make_block_mvd Generate data.frame for MDR S-map

Usage

make_block_mvd(
  block,
  uic_res,
  effect_var,
  E_effect_var,
  cause_var_colname = "cause_var",
  include_var = "strongest_only",
  p_threshold = 0.05,
  sort_tp = TRUE,
  silent = FALSE
)

Arguments

`block`	Data.frame contains time series data.
`uic_res`	Data.frame contains UIC results. Usually this is the output of `uic_across()`, but custom data.frame may be usable.
`effect_var`	Character or Numeric. Column name or index of the effect variable.
`E_effect_var`	Numeric. Optimal embedding dimension of the effect variable.
`cause_var_colname`	Character. A column name for causal variables in `uic_res`.
`include_var`	Character. `all_significant`, `strongest_only`, or `tp0_only`. If `all_significant`, all significantly influencing variables are used for the embedding. If `strongest_only`, tp with the strongest influence for each variable is used. If `tp0_only`, only variables with no time-delay are used.
`p_threshold`	Numeric. Rows with pval larger than `p_threshold` is removed.
`sort_tp`	Logical. If TRUE, `block_mvd` is sorted according to `tp` for each causal variable.
`silent`	Logical. if `TRUE`, progress message will not be shown.