constraints_api: Add, update, or reset a 'constraints' object within an...

In tidysynthesis: A Common API for Synthesizing Data

Add, update, or reset a constraints object within an existing roadmap.

Description

Add, update, or reset a constraints object within an existing roadmap.

Usage

add_constraints(roadmap, constraints)

update_constraints(roadmap, ...)

reset_constraints(roadmap)

Arguments

roadmap	A roadmap object
constraints	A constraints object.
...	Optional named parameters passed to constraints().

Value

A new roadmap object.

A roadmap object with added constraints.

A roadmap object with updated constraints.

A roadmap object with reset constraints.

Examples

rm <- roadmap(
  conf_data = acs_conf_nw,
  start_data = acs_start_nw
)

constraints_df_num <- 
  tibble::tribble(~var, ~min, ~max, ~conditions,
                  "transit_time", 0, 300, "TRUE")

constraints <- constraints(
  schema = rm[["schema"]],
  constraints_df_num = constraints_df_num,
  max_z_num = 0
)

rm |>
  add_constraints(constraints)


rm <- roadmap(
  conf_data = acs_conf_nw,
  start_data = acs_start_nw
)

constraints_df_num <- 
  tibble::tribble(~var, ~min, ~max, ~conditions,
                  "transit_time", 0, 300, "TRUE")

constraints <- constraints(
  schema = rm[["schema"]],
  constraints_df_num = constraints_df_num,
  max_z_num = 0
)

rm |>
  update_constraints(constraints)


rm <- roadmap(
  conf_data = acs_conf_nw,
  start_data = acs_start_nw
)

constraints_df_num <- 
  tibble::tribble(~var, ~min, ~max, ~conditions,
                  "transit_time", 0, 300, "TRUE")

constraints <- constraints(
  schema = rm[["schema"]],
  constraints_df_num = constraints_df_num,
  max_z_num = 0
)

rm <- rm |>
  add_constraints(constraints)

reset_constraints(rm)

tidysynthesis documentation built on March 17, 2026, 1:06 a.m.