docs: avoid writing to user directory

R/IV_report.R

@@ -27,13 +27,18 @@
 #' @param timestamp Logical vector specifying whether to include a timestamp in
 #'   the file name. Defaults to TRUE.
 #'
-#' @examples
-#' \donttest{
+#' @section Creating a report:
+#'
+#' Below is an example on how to run the report.
+#'
+#' ```
+#' library(dplyr)
+#'
 #' sq_data %>%
-#'   mutate(X = ifelse(Collaboration_hours > 12, 1, 0)) %>% # Simulate binary variable
+#'   mutate(CH_binary = ifelse(Collaboration_hours > 12, 1, 0)) %>% # Simulate binary variable
 #'   IV_report(outcome =  "CH_binary",
 #'             predictors = c("Email_hours", "Workweek_span"))
-#' }
+#' ```
 #'
 #' @family Reports
 #' @family Variable Association

R/validation_report.R

@@ -52,13 +52,16 @@
 #' @param timestamp Logical vector specifying whether to include a timestamp in
 #'   the file name. Defaults to `TRUE`.
 #'
-#' @examples
-#' \donttest{
+#' @section Creating a report:
+#'
+#' Below is an example on how to run the report.
+#'
+#' ```
 #' validation_report(dv_data,
 #'                   meeting_data = mt_data,
 #'                   hrvar = "Organization")
+#' ```
 #'
-#' }
 #'
 #' @importFrom purrr map_if
 #' @importFrom dplyr `%>%`

man/IV_report.Rd

@@ -48,15 +48,18 @@ data exploration technique that helps determine which columns in a data set
 have predictive power or influence on the value of a specified dependent
 variable.
 }
-\examples{
-\donttest{
+\section{Creating a report}{
+
+
+Below is an example on how to run the report.\preformatted{library(dplyr)
+
 sq_data \%>\%
-  mutate(X = ifelse(Collaboration_hours > 12, 1, 0)) \%>\% # Simulate binary variable
+  mutate(CH_binary = ifelse(Collaboration_hours > 12, 1, 0)) \%>\% # Simulate binary variable
   IV_report(outcome =  "CH_binary",
             predictors = c("Email_hours", "Workweek_span"))
 }
-
 }
+
 \seealso{
 Other Reports: 
 \code{\link{capacity_report}()},

man/validation_report.Rd

@@ -75,15 +75,15 @@ make the variable names consistent with a Standard Person Query.
 You can browse each individual function for details on calculations.
 }
 
-\examples{
-\donttest{
-validation_report(dv_data,
+\section{Creating a report}{
+
+
+Below is an example on how to run the report.\preformatted{validation_report(dv_data,
                   meeting_data = mt_data,
                   hrvar = "Organization")
-
+}
 }
 
-}
 \seealso{
 Other Reports: 
 \code{\link{IV_report}()},