An open API service indexing awesome lists of open source software.

https://github.com/inbo/multimput

multimput is an R package that assists with analysing dataset with missing values using multiple imputation.
https://github.com/inbo/multimput

imputation imputation-model package r

Last synced: 5 months ago
JSON representation

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

Awesome Lists containing this project

README

          

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Life cycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing-1)
[![License](http://img.shields.io/badge/license-GPL--3-blue.svg?style=flat)](http://www.gnu.org/licenses/gpl-3.0.html)
[![Release](https://img.shields.io/github/release/qubyte/rubidium.svg)](https://github.com/inbo/multimput/releases)
[![check package](https://github.com/inbo/multimput/actions/workflows/check_on_branch.yml/badge.svg)](https://github.com/inbo/multimput/actions/workflows/check_on_branch.yml)
![r-universe name](https://inbo.r-universe.dev/badges/:name?color=c04384)
![r-universe package](https://inbo.r-universe.dev/badges/multimput)
[![Codecov test coverage](https://codecov.io/gh/inbo/multimput/branch/main/graph/badge.svg)](https://app.codecov.io/gh/inbo/multimput?branch=main)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/inbo/multimput.svg)
![GitHub repo size](https://img.shields.io/github/repo-size/inbo/multimput.svg)
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.48423.svg)](http://dx.doi.org/10.5281/zenodo.48423)

# 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](https://github.com/inbo/multimput/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
```