Expand code documentation

coatless-r-n-d · Jun 12, 2024 · 3a13a34 · 3a13a34
1 parent 67b52b9
commit 3a13a34
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/R/residual_surrealism.R b/R/residual_surrealism.R
@@ -1,16 +1,30 @@
 #' Residual (Sur)Realism
 #'
-#' A dataset containing residuals from a surreal model.
+#' A dataset that yields a model with surreal residuals.
 #'
 #' @format 
 #' A data frame with 5,395 rows and 7 columns:
-#'
+#' \describe{
+#'   \item{V1}{Target variable of interest}
+#'   \item{V2}{First predictor variable}
+#'   \item{V3}{Second predictor variable}
+#'   \item{V4}{Third predictor variable}
+#'   \item{V5}{Fourth predictor variable}
+#'   \item{V6}{Fiveth predictor variable}
+#'   \item{V7}{Sixth predictor variable}
+#' }
+#' 
 #' @examples
+#' # Load the data
 #' data(residual_surrealism)
 #' 
+#' # Fit a model
 #' model = lm(V1 ~ ., residual_surrealism)
 #' 
+#' # Graph the residuals vs. fitted values
 #' plot(fitted(model),resid(model))
+#' 
+#' # Add a line at y = 0
 #' abline(0, 0, col = "red")
 #' 
 #' @source 

diff --git a/man/altdocwebrdemo-package.Rd b/man/altdocwebrdemo-package.Rd
diff --git a/man/residual_surrealism.Rd b/man/residual_surrealism.Rd