Extend documentation output ggmice()

R/ggmice.R

@@ -3,7 +3,13 @@
 #' @param data An incomplete dataset (of class `data.frame`), or an object of class [`mice::mids`].
 #' @param mapping A list of aesthetic mappings created with [ggplot2::aes()].
 #'
-#' @return An object of class [`ggplot2::ggplot`].
+#' @return An object of class [`ggplot2::ggplot`]. The [`ggmice::ggmice`] function returns output
+#' equivalent to [`ggplot2::ggplot`] output, with a few important exceptions:
+#'
+#' - The theme is set to [`ggmice::theme_mice`].
+#' - The color scale is set to the [`mice::mdc`] colors.
+#' - The `colour` aesthetic is set to `.where`, an internally defined variable which distinguishes
+#' observed data from missing data or imputed data (for incomplete and imputed data, respectively).
 #'
 #' @examples
 #' dat <- mice::nhanes
@@ -101,8 +107,8 @@ ggmice <- function(data = NULL,
           .imp = 0,
           .id = rownames(data$data),
           data$data
-        )[!miss_xy, ],
-        data.frame(.where = "imputed", mice::complete(data, action = "long"))[where_xy, ]
+        )[!miss_xy,],
+        data.frame(.where = "imputed", mice::complete(data, action = "long"))[where_xy,]
       ),
       .where = factor(
         .where,