forked from amices/ggmice
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
82 lines (59 loc) · 4.12 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file and render with devtools::build_readme() -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# `ggmice` <a href='https://amices.org/ggmice/'><img src="man/figures/logo.png" align="right" height="139" /></a>
<!-- badges: start -->
[](https://cran.r-project.org/package=ggmice)
[](https://cranlogs.r-pkg.org/badges/grand-total/ggmice)
[](https://amices.r-universe.dev/ggmice)
[](https://doi.org/10.5281/zenodo.6532702)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/amices/ggmice/blob/main/DESCRIPTION)
[](https://github.com/amices/ggmice/actions)
<!-- badges: end -->
## Visualizations for `mice` with `ggplot2`
Enhance a [`mice`](https://amices.org/mice/) imputation workflow with visualizations for incomplete and/or imputed data. The `ggmice` functions produce [`ggplot`](https://ggplot2.tidyverse.org/reference/ggplot) objects which may be easily manipulated or extended. Use `ggmice` to inspect missing data, develop imputation models, evaluate algorithmic convergence, or compare observed versus imputed data.
## Installation
You can install the latest `ggmice` release from [CRAN](https://CRAN.R-project.org/package=ggmice) with:
``` r
install.packages("ggmice")
```
Alternatively, you could install the development version of `ggmice` from [GitHub](https://github.com/amices) with:
``` r
# install.packages("devtools")
devtools::install_github("amices/ggmice")
```
## Example
Inspect the missing data in an incomplete dataset and subsequently evaluate the imputed data points against observed data. See the [Get started](https://amices.org/ggmice/articles/ggmice.html) vignette for an overview of all functionalities. Example data from [`mice`](https://amices.org/mice/reference/boys), showing height (in cm) by age (in years).
```{r example, message=FALSE, warning=FALSE, echo=TRUE, results='hide', fig.keep='all'}
# load packages
library(ggplot2)
library(mice)
library(ggmice)
# load some data
dat <- boys
# visualize the incomplete data
ggmice(dat, aes(age, hgt)) + geom_point()
# impute the incomplete data
imp <- mice(dat, m = 1, seed = 1)
# visualize the imputed data
ggmice(imp, aes(age, hgt)) + geom_point()
```
## Acknowledgements
The `ggmice` package is developed with guidance and feedback from the [Amices](https://github.com/amices) team. The `ggmice` hex is based on the [`ggplot2`](https://github.com/tidyverse/ggplot2/) and [`mice`](https://github.com/amices/mice) hex designs.
This project has received funding from the European Union’s Horizon 2020 research and innovation programme under ReCoDID grant agreement No 825746.
## Code of Conduct
You are invited to join the improvement and development of `ggmice`. Please note that the project is released with a [Contributor Code of Conduct](https://amices.org/ggmice/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
[](https://app.codecov.io/gh/amices/ggmice?branch=main)
[](https://bestpractices.coreinfrastructure.org/projects/6036)
[](https://fair-software.eu)