sdbuildR (version 2.0.0)

as.data.frame.verify_stockflow: Convert verify() results to a data frame

Description

Converts a verify_stockflow object to a data frame.

Usage

# S3 method for verify_stockflow
as.data.frame(
  x,
  row.names = NULL,
  optional = FALSE,
  which = c("tests", "sims")[1],
  direction = "long",
  test = NULL,
  label = NULL,
  ignore_case = TRUE,
  status = c("pass", "fail", "error", "skip"),
  condition = NULL,
  ...
)

Value

A data.frame. Column set depends on which:

• "tests": test, label, status, outcome, expr_str, condition, conditions, message.

• "sims" (long): test, condition, conditions, time, variable, value.

• "sims" (wide): test, condition, conditions, time, then one column per variable.

Arguments

x

A verify_stockflow object (output of verify()).

row.names

NULL or a character vector giving row names (optional).

optional

Ignored; present for compatibility.

which

Character. "tests" (default) or "sims". Partial matching supported.

direction

Character. "long" (default) or "wide". Only used when which = "sims".

test

Integer vector of test number(s) to display (1-based). Defaults to NULL (show all tests). Can be combined with label (intersection).

label

Character vector of regex patterns for partial, case-insensitive label matching. A test is included if its label matches any pattern. E.g., c("non-neg", "beta") returns tests matching either fragment. Can be combined with test (intersection).

ignore_case

Logical; whether label matching is case-insensitive. Default TRUE.

status

Optional character vector of statuses to include (e.g., c("fail", "error")). Defaults to all statuses.

• which = "tests": filters rows by test status.

• which = "sims": filters to conditions that have at least one test with a matching status.

condition

Optional integer vector of condition numbers to filter by. For which = "sims", keeps only the matching condition simulations. For which = "tests", keeps only tests belonging to those conditions.

...

Additional arguments (unused).

Details

which = "tests" (default) returns one row per unit test with columns test, label, status, outcome, expr_str, conditions, and message. Use test, label, and status to filter.

which = "sims" returns the underlying simulation time-series in long format with columns test (test number(s) that used this simulation, as a comma-separated string), conditions (specified conditions per test, if any), time, variable, and value. Each unique condition generates one simulation; if multiple tests share a condition their numbers are combined in test (e.g. "1, 3"). When filtering with test, the displayed test value shows only the requested matching test number(s) for the retained simulation row(s). Use direction = "wide" to pivot variables into columns.

Examples

# Create model with 2 unit tests
sfm <- stockflow("SIR") |>
  unit_test(expr = all(susceptible >= 0)) |>
  # Add test with conditions
  unit_test(
    label = "lower infection rate",
    expr = all(susceptible >= 0),
    conditions = list(infection_rate = 0.1)
  )
res <- verify(sfm)

# Test results (default)
as.data.frame(res)

# Simulation time-series (long format)
as.data.frame(res, which = "sims") |> head()

# Simulation time-series (wide format)
as.data.frame(res, which = "sims", direction = "wide") |> head()

# Filter to simulation for test 2 only
as.data.frame(res, which = "sims", test = 2) |> head()

# Only simulations for passing tests
as.data.frame(res, which = "sims", status = "pass") |> head()