data_helpers: Data helpers

In macartan/gbiqq: Make, Update, and Query Binary Causal Models

Data helpers

Description

Various helpers to simulate data and to manipulate data types between compact and long forms.

Take a 'data.frame' and return compact 'data.frame' of event types and strategies.

Usage

collapse_data(
  data,
  model,
  drop_NA = TRUE,
  drop_family = FALSE,
  summary = FALSE
)

expand_data(data_events = NULL, model)

Arguments

data	A data.frame. Data of nodes that can take three values: 0, 1, and NA. In long form as generated by make_events
model	A causal_model. A model object generated by make_model.
drop_NA	Logical. Whether to exclude strategy families that contain no observed data. Exceptionally if no data is provided, minimal data on data on first node is returned. Defaults to 'TRUE'
drop_family	Logical. Whether to remove column strategy from the output. Defaults to 'FALSE'.
summary	Logical. Whether to return summary of the data. See details. Defaults to 'FALSE'.
data_events	A data.frame. It must be compatible with nodes in model. The default columns are event, strategy and count.

Value

A vector of data events

If summary = TRUE 'collapse_data' returns a list containing the following components:

data_events	A compact data.frame of event types and strategies.
observed_events	A vector of character strings specifying the events observed in the data
unobserved_events	A vector of character strings specifying the events not observed in the data

A data.frame with rows as data observation

Examples

model <- make_model('X -> Y')

df <- data.frame(X = c(0,1,NA), Y = c(0,0,1))

df |> collapse_data(model)

# Illustrating options

df |> collapse_data(model, drop_NA = FALSE)

df |> collapse_data(model, drop_family = TRUE)

df |> collapse_data(model, summary = TRUE)

# Appropriate behavior given restricted models

model <- make_model('X -> Y') |>
  set_restrictions('X[]==1')
df <- make_data(model, n = 10)
df[1,1] <- ''
df |> collapse_data(model)

df <- data.frame(X = 0:1)
df |> collapse_data(model)




model <- make_model('X->M->Y')
make_events(model, n = 5) |>
  expand_data(model)
make_events(model, n = 0) |>
  expand_data(model)
 

macartan/gbiqq documentation built on Oct. 17, 2024, 6:37 a.m.