new_vimmi: Constructor for vimmi objects

View source: R/vimmi.R

new_vimmiR Documentation

Constructor for vimmi objects

Description

Constructor for vimmi objects

Usage

new_vimmi(
  data,
  imp,
  where,
  m,
  nmis,
  method,
  boot,
  uncert,
  call,
  tuning_log = NULL,
  chain = NULL,
  seed = NULL,
  model_error = NULL
)

Arguments

data

Original data.frame/data.table with NAs intact

imp

Named list: per variable with missings, a data.frame with nmis rows and m columns of imputed values

where

Logical matrix indicating which cells were imputed

m

Number of imputations

nmis

Named integer vector of missing counts per variable

method

Named list of methods used per variable

boot

Logical: was bootstrap used?

uncert

Character: uncertainty method used

call

The original function call

tuning_log

Optional tuning report from the (single) tuning run, shared by all m imputations; NULL when tuning was not requested

chain

Optional per-iteration chain statistics: list(mean = , var = ) of arrays with dimensions [variable, iteration, imputation] holding the mean and variance of the imputed values of each numeric variable after each sequential iteration (the basis of plot.vimmi trace plots)

seed

The seed applied at entry of the vimpute() call (NULL when none was set)

model_error

Optional per-variable model-quality list (NRMSE/PFC, from the first imputation run), as in attr(result, "model_error") of single runs

Value

A vimmi object


VIM documentation built on Sept. 2, 2026, 5:07 p.m.