observed_data: Apply a missingness mask to complete data

In simulab: Simulates a Wide Variety of Data Shapes, Sizes and Distributions

Apply a missingness mask to complete data

Description

Sets every cell the mask flags to NA, leaving the complete data otherwise untouched, and keeps the mask alongside the result as a tidy component.

Usage

observed_data(data, missingness, id = NULL)

Arguments

data	Complete base data.frame, or a simulab_sim, with as many rows as missingness and in the same row order.
missingness	A logical mask returned by missingness_matrix(), with one row per row of data. Its columns that also name columns of data, other than those listed in id, are the targets, and each must be logical.
id	Identifier columns the mask carries that are never made missing. A character vector, or NULL (the default). Name the identifier columns of the mask here, or they are treated as targets and rejected for not being logical.

Value

A simulab_sim base data.frame with the columns and rows of data, the flagged cells of the target variables replaced by NA. The component missingness, reached with as.data.frame(x, what = "missingness"), is the mask in long form, one row per observation and target variable, with columns observation, variable and the logical missing.

Examples

data <- data.frame(id = 1:100, outcome = stats::rnorm(100))
mask <- missingness_matrix(
  data,
  specification = define_missingnesses(define_missingness("outcome", formula = "0.3")),
  seed = 1
)

result <- observed_data(data, missingness = mask, id = "id")
head(result)

simulab documentation built on Oct. 15, 2026, 5:08 p.m.