set_max_lag: Set a Maximum Tier Lag on Knowledge

View source: R/knowledge-verbs.R

set_max_lagR Documentation

Set a Maximum Tier Lag on Knowledge

Description

Forbids every edge between variables that are more than max_lag tiers apart, based on the tiers currently defined on kn.

Usage

set_max_lag(kn, max_lag)

Arguments

kn

A Knowledge object that already has tiers defined.

max_lag

A single positive integer: the maximum allowed tier distance between the endpoints of an edge.

Value

The updated Knowledge object, with the new forbidden edges added and max_lag stored on it.

See Also

Other knowledge helpers: +.Knowledge(), add_exogenous(), add_tier(), add_to_tier(), add_vars(), as_bnlearn_knowledge(), as_pcalg_constraints(), as_tetrad_knowledge(), convert_tiers_to_forbidden(), deparse_knowledge(), forbid_edge(), get_tiers(), knowledge(), knowledge_to_caugi(), remove_edge(), remove_tiers(), remove_vars(), reorder_tiers(), reposition_tier(), require_edge(), seq_tiers(), set_knowledge(), unfreeze()

Examples

data(tpc_example)

# verb form: forbid edges that skip more than one tier
kn1 <- knowledge(
  tpc_example,
  tier(
    child ~ starts_with("child"),
    youth ~ starts_with("youth"),
    old ~ starts_with("oldage")
  )
) |>
  set_max_lag(1)

print(kn1)

# DSL form: max_lag() inside tier() is equivalent
kn2 <- knowledge(
  tpc_example,
  tier(
    child ~ starts_with("child"),
    youth ~ starts_with("youth"),
    old ~ starts_with("oldage"),
    max_lag(1)
  )
)

print(identical(kn1, kn2))

causalDisco documentation built on Nov. 17, 2026, 5:08 p.m.