check_entity_ids: Check if ids exist in Entity.

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

Description

Check if ids exist in Entity.

Usage

check_entity_ids(x, ids, include_removed_data = FALSE, informative = TRUE)

assert_entity_ids(
  x,
  ids,
  include_removed_data = FALSE,
  informative = TRUE,
  .var.name = checkmate::vname(x),
  add = NULL
)

test_entity_ids(x, ids, include_removed_data = FALSE, informative = TRUE)

expect_entity_ids(
  x,
  ids,
  include_removed_data = FALSE,
  informative = TRUE,
  info = NULL,
  label = vname(x)
)

Arguments

x	Entity an R6 Entity object
ids	(logical(1)) Ids of Entity to check.
include_removed_data	(any) Should the removed data of x be checked.
informative	(logical(1)) Whether to return the missing ids in error message.
.var.name	[character(1)] The custom name for x as passed to any assert* function. Defaults to a heuristic name lookup.
add	checkmate::AssertCollection Collection to store assertions. See checkmate::AssertCollection.
info	[character(1)] See expect_that
label	[character(1)] See expect_that

Value

(logical(1)).

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