Add a data example

coatless-r-n-d · Jun 11, 2024 · f825633 · f825633
1 parent 4b04c89
commit f825633
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 0 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -20,3 +20,4 @@ RoxygenNote: 7.3.1
 Roxygen: list(markdown = TRUE)
 Suggests: 
     altdoc
+LazyData: true
diff --git a/R/residual_surrealism.R b/R/residual_surrealism.R
@@ -0,0 +1,19 @@
+#' Residual (Sur)Realism
+#'
+#' A dataset containing residuals from a surreal model.
+#'
+#' @format 
+#' A data frame with 5,395 rows and 7 columns:
+#'
+#' @examples
+#' data(residual_surrealism)
+#' 
+#' model = lm(V1 ~ ., residual_surrealism)
+#' 
+#' plot(fitted(model),resid(model))
+#' abline(0, 0, col = "red")
+#' 
+#' @source 
+#' Leonard A Stefanski
+#' <https://www.tandfonline.com/doi/abs/10.1198/000313007X190079>
+"residual_surrealism"
diff --git a/data/residual_surrealism.rda b/data/residual_surrealism.rda
diff --git a/man/residual_surrealism.Rd b/man/residual_surrealism.Rd