dont write files into anything but tempdir

rubenarslan · Mar 21, 2018 · 893871e · 893871e
1 parent 6e8a443
commit 893871e
Show file tree

Hide file tree

Showing 16 changed files with 443 additions and 1,050 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -6,7 +6,7 @@ Description: Easily automate the following tasks to describe data frames:
   combine this information with metadata (such as item labels and labelled values) that is derived from R attributes.
   To do so, the package relies on 'rmarkdown' partials, so you can generate HTML, PDF, and Word documents. Codebooks
   are also available as tables (CSV, Excel, etc.).
-Version: 0.5.7
+Version: 0.5.8
 Authors@R: person("Ruben", "Arslan", email = "[email protected]", role = c("aut", "cre"))
 Depends: R (>= 3.0.1)
 URL: https://github.com/rubenarslan/codebook

diff --git a/R/codebook.R b/R/codebook.R
@@ -21,7 +21,10 @@
 #'
 #' @export
 #' @examples
-#' # will generate figures in a figure/ subdirectory
+#' # will generate figures in a temporary directory
+#' old_base_dir <- knitr::opts_knit$get("base.dir")
+#' knitr::opts_knit$set(base.dir = tempdir())
+#' on.exit(knitr::opts_knit$set(base.dir = old_base_dir))
 #' data("bfi")
 #' bfi <- bfi[, c("BFIK_open_1", "BFIK_open_1")]
 #' md <- codebook(bfi, survey_repetition = "single", metadata_table = FALSE)
@@ -273,7 +276,10 @@ codebook_items <- function(results, indent = "##") {
 #'
 #' @export
 #' @examples
-#' # will generate figure in a figure/ subdirectory
+#' # will generate figures in a temporary directory
+#' old_base_dir <- knitr::opts_knit$get("base.dir")
+#' knitr::opts_knit$set(base.dir = tempdir())
+#' on.exit(knitr::opts_knit$set(base.dir = old_base_dir))
 #' data("bfi")
 #' bfi <- bfi[,c("BFIK_open", paste0("BFIK_open_", 1:4))]
 #' codebook_component_scale(bfi[,1], "BFIK_open", bfi[,-1],
@@ -303,8 +309,11 @@ codebook_component_scale <- function(scale, scale_name, items, reliabilities,
 #'
 #' @export
 #' @examples
-#' # will generate figure in a figure/ subdirectory
-#' #' data("bfi")
+#' # will generate figure in a temporary directory
+#' old_base_dir <- knitr::opts_knit$get("base.dir")
+#' knitr::opts_knit$set(base.dir = tempdir())
+#' on.exit(knitr::opts_knit$set(base.dir = old_base_dir))
+#' data("bfi")
 #' codebook_component_single_item(bfi$BFIK_open_1, "BFIK_open_1")
 codebook_component_single_item <- function(item, item_name, indent = '##') {
   options <- list(
@@ -494,3 +503,5 @@ skim_to_wide_labelled <- function(...) {
   on.exit(skimr::skim_with_defaults())
   skimr::skim_to_wide(...)
 }
+
+
diff --git a/cran-comments.md b/cran-comments.md
@@ -1,5 +1,13 @@
 ## Resubmission
-This is a second resubmission. In this version I have:
+This is the third resubmission. In this version I have:
+
+* added the following code to examples that would have created figures in the user
+  work space, so that figures are now written to a tempdir:
+  #' old_base_dir <- knitr::opts_knit$get("base.dir")
+  #' knitr::opts_knit$set(base.dir = tempdir())
+  #' on.exit(knitr::opts_knit$set(base.dir = old_base_dir))
+
+In the second resubmission I
 
 * changed the title to omit "in R"
 * changed the description to put 'rmarkdown' in single quotes

diff --git a/docs/articles/codebook.html b/docs/articles/codebook.html
diff --git a/docs/articles/codebook_files/figure-html/age_distribution-1.png b/docs/articles/codebook_files/figure-html/age_distribution-1.png
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/reference/codebook.html b/docs/reference/codebook.html
diff --git a/docs/reference/codebook_component_scale.html b/docs/reference/codebook_component_scale.html
diff --git a/docs/reference/codebook_component_single_item.html b/docs/reference/codebook_component_single_item.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/knit_print.alpha.html b/docs/reference/knit_print.alpha.html