
<!-- README.md is generated from README.Rmd. Please edit that file -->

# vismi <a href="https://agnesdeng.github.io/vismi/"><img src="man/figures/logo.png" align="right" height="138" alt="vismi website" /></a>

The R package **vismi** ([Visual Diagnostics for Multiple
Imputation](https://agnesdeng.github.io/vismi/)) provides a
comprehensive suite of visual diagnostics for assessing the quality of
multiply imputed data. The package supports imputed data generated by
various multiple imputation methods, including `mixgb`, `mice`, and
more.

<!-- badges: start -->

[![Made with
R](https://img.shields.io/badge/Made%20With-R-9cf)](https://github.com/agnesdeng/vismi)
[![CRAN
version](https://img.shields.io/cran/v/vismi?color=9cf)](https://cran.r-project.org/package=vismi)
[![GitHub release (latest by
date)](https://img.shields.io/github/v/release/agnesdeng/vismi?logo=github&color=green)](https://github.com/agnesdeng/vismi/releases)
[![R-CMD-check](https://github.com/agnesdeng/vismi/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/agnesdeng/vismi/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## Overview

The package has been completely redesigned. Please check **Articles**
section for more details.

- `vismi()`: visualise multiply-imputed missing data through
  distributional characteristics

- `vismi_overimp()`: visualise multiply-imputed missing data through
  overimputation

- `vismi_converge()`: visualise convergence diagnostics for imputed
  values of an incomplete variable

With the support of
[trelliscopejs](https://hafen.github.io/trelliscopejs/), **vismi**
provides trelliscope displays to inspect all variables at once via

- `trellis_vismi()`

- `trellis_vismi_overimp()`

- `trellis_vismi_converge()`

## Installation

You can install the current development version of vismi from
[GitHub](https://github.com/agnesdeng) with:

``` r
devtools::install_github("agnesdeng/vismi")
```
