tidysynthesis (version 0.1.2)

replicates_api: Add, update, or reset a replicates object within an existing roadmap.

Description

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

Usage

add_replicates(roadmap, replicates)
update_replicates(roadmap, ...)
reset_replicates(roadmap)

Value

A new roadmap object.

A new roadmap object with the added replicates.

A new roadmap object with updated replicates.

A new roadmap object with reset replicates.

Arguments

roadmap

A roadmap object

replicates

A replicates object.

...

Optional named parameters passed to replicates().

Examples

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

new_replicates <- replicates(end_to_end_replicates = 2)

rm |>
  add_replicates(new_replicates)


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

rm |>
  update_replicates(start_data_replicates = 3)


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

rm <- rm |>
  add_replicates(replicates(start_data_replicates = 3))
  
 reset_replicates(roadmap = rm)