flow: Construct the value for the flow argument

In vistla: Detecting Influence Paths with Information Theory

Construct the value for the flow argument

Description

Vistla builds the tree by optimising the influence score over path, which is given by the iota function. The flow argument of the vistla function can be used to modify the default iota and some associated behaviours. This function can be used to construct the proper value for this argument.

Usage

flow(code, ..., from = TRUE, into = FALSE, down, up, forcepath)

## S3 method for class 'vistla_flow'
print(x, ...)

Arguments

code	Character code of the flow parameter, like "fromdown". If given, overrides other arguments.
...	ignored.
from	if TRUE, paths must satisfy data processing inequality as going from the root.
into	if TRUE, paths must satisfy data processing inequality as going into the root.
down	if TRUE, subsequent features on the path must have lower mutual information with the root; by default, true when from is true but if both from and into are true. Can't be true together with up.
up	if TRUE, subsequent features on the path must have higher mutual information with the root; by default, true when into is true but if both from and into are true. Can't be true together with down.
forcepath	when neither up or down is true, vistla may output walks rather than paths, i.e., sequences of features which are not unique. Yet, when this argument is set to TRUE, additional condition is checked to forbid such self-intersections. One should note that this check is computationally expensive, though. By default true when both up and down are false.
x	flow value to print.

Value

A vistla_flow object which can be passed to the vistla function; in practice, a single integer value.

vistla documentation built on Sept. 28, 2024, 1:08 a.m.