inspect: Inspect Entity

In dymium-org/dymiumCore: A Toolkit for Building a Dynamic Microsimulation Model for Integrated Urban Modelling

Description

Return and print to console the attribute data of entities within an Entity object or its inheritance object. A related entity object can also be queried at the same time.

Usage

inspect(entity, ids, related_entity = NULL, verbose = TRUE)

Arguments

entity	an Entity object or its inheritance object
ids	a integer vactor that contains the ids of the entities to be inspected
related_entity	an Entity object or its inheritance object which must be related to entity but not the same as entity. For example, related_entity can be Household if entity is Individual.
verbose	:: logical(1) Should the data be printed to console.

Value

a named ist of data.tables.

Examples

create_toy_world()

inspect(
  entity = world$get("Individual"),
  ids = c(1:3),
  related_entity = world$get("Household")
)

dymium-org/dymiumCore documentation built on July 18, 2021, 5:10 p.m.