Update ReplicaStructure State — updateState • replica

Attaches a synthetic population and household-position column to a ReplicaStructure object.

Usage

updateState(object, df_synth_pop, household_position_column)

# S4 method for class 'ReplicaStructure'
updateState(object, df_synth_pop, household_position_column)

Arguments

object: A ReplicaStructure object.
df_synth_pop: Synthetic population.
household_position_column: Character string identifying the household-position column.

Value

An updated ReplicaStructure object.

Details

This method is typically called prior to household generation.

See also

createFromMembers, ReplicaStructure

Examples

if (FALSE) { # \dontrun{

hh <- updateState(
  hh,
  pop,
  "household_position"
)

} # }