Add example

hanneoberman · May 16, 2023 · 2fae4eb · 2fae4eb
1 parent 1fd7c02
commit 2fae4eb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -5,7 +5,7 @@ Version: 0.0.0.9000
 Authors@R: 
  c(person("Hanne", "Oberman", , "[email protected]", role = c("aut", "cre"),
  comment = c(ORCID = "0000-0003-3276-2141")),
- person("Johanna", "Muñoz", , "h.i.oberman@uu.nl", role = c("aut", "ctb"),
+ person("Johanna", "Muñoz", , "j.munozavila@umcutrecht.nl", role = c("aut", "ctb"),
  comment = c(ORCID = "0000-0002-2384-5415")))
 Description: Impute (clustered) data according to the Heckman selection
  model for MNAR data.

diff --git a/R/mice.impute.2l.heckman.R b/R/mice.impute.2l.heckman.R
@@ -44,6 +44,12 @@
 #' @author Julius Center Methods Group UMC, 2022
 #' @family univariate imputation functions
 #' @keywords datagen
+#' @examples
+#' # example code
+#' library(mice)
+#' pred <- make.predictorMatrix(nhanes)
+#' pred[, "age"] <- -3
+#' mice(nhanes, pred = pred, meth = "2l.2stage.heckman")
 #' @export
 #'
 

diff --git a/data/obesity.rda b/data/obesity.rda