inbo / multimput

multimput is an R package that assists with analysing dataset with missing values using multiple imputation.

multimput

Rationale

The multimput package was originally intended to provide the data and code to replicate the results of Onkelinx, Devos, and Quataert (2016). This paper is freely available at http://dx.doi.org/10.1007/s10336-016-1404-9. The functions were all rewritten to make them more user-friendly and more generic. In order to make the package more compact, we removed the original code and data starting for version 0.2.6. However both the original code and data remain available in the older releases.

Documentation

All helpfiles and vignettes are available at https://inbo.github.io/multimput/

Installation

This package requires the INLA package. You need to install it with install.packages("INLA", repos = "https://inla.r-inla-download.org/R/stable"). If this fails you can use remotes::install_github("inbo/INLA"). Note that the latter is just a read-only mirror which is infrequently updated. Hence installing INLA from https://inla.r-inla-download.org is highly recommended.

Once INLA is installed, you can install multimput using the remotes package: remotes::install_github("inbo/multimput", build_vignettes = TRUE)). To view the vignette use vignette("Impute", package = "multimput"). The vignette is also available at https://inbo.github.io/multimput/articles/impute.html

A docker image with all the required dependencies is available from https://hub.docker.com/r/inbobmk/multimput/. Use docker pull inbobmk/multimput to get it.

Folder structure

The folder structure is that of a typical R packages with the mandatory R folder (definition of the functions) and man (helpfiles in Rd format). data is an optional folder in which some data sets are stored. The optional test folder contains the unit tests using the infrastructure from the testthat package. The optional vignette folder contains examples of the available themes. man-roxygen contains roxygen2 templates for the documentation.

multimput
|-- data
|-- man
|-- man-roxygen
|-- R
|-- tests
   |-- testthat
|-- vignettes