Deprecate beautier functions

R/create_beautier_tempfolder.R

@@ -1,18 +1,12 @@
+#' Deprecated function, use \link[beautier]{create_beautier_tempfolder}.
+#'
 #' Create the default `beautier` temporary folder
 #' @return nothing
-#' @examples
-#' check_empty_beaustier_folders()
-#'
-#' create_beautier_tempfolder()
-#'
-#' remove_beaustier_folders()
-#' check_empty_beaustier_folders()
 #' @author Richèl J.C. Bilderbeek
 #' @export
 create_beautier_tempfolder <- function() {
-  dir.create(
-    dirname(beautier::get_beautier_tempfilename()),
-    showWarnings = FALSE,
-    recursive = TRUE
+  stop(
+    "'beastier::create_beautier_tempfolder' is deprecated, ",
+    "use 'beautier::create_beautier_tempfolder' instead"
   )
 }

R/remove_beaustier_folders.R

@@ -12,5 +12,5 @@
 #' @export
 remove_beaustier_folders <- function() {
   beastier::remove_beastier_folder()
-  beastier::remove_beautier_folder()
+  beautier::remove_beautier_folder()
 }

R/remove_beautier_folder.R

@@ -1,17 +1,17 @@
-#' Check there are no files in the default `beautier` folder
+#' Deprecated function, use \link[beautier]{remove_beautier_folder}.
+#'
+#' Deprecated function, use \link[beautier]{remove_beautier_folder}.
 #'
 #' Check there are no files in the default `beautier` folder.
 #' The goal is to make sure no temporary files are left undeleted.
 #' Will \link{stop} if there are files in the `beautier` folder.
 #'
 #' @return Nothing.
-#' @examples
-#' remove_beautier_folder()
 #' @author Richèl J.C. Bilderbeek
 #' @export
 remove_beautier_folder <- function() {
-  folder_name <- beautier::get_beautier_folder()
-  if (dir.exists(folder_name)) {
-    unlink(folder_name, recursive = TRUE)
-  }
+  stop(
+    "'beastier::remove_beautier_folder' is deprecated, ",
+    "use 'beautier::remove_beautier_folder' instead"
+  )
 }

R/run_beast2_from_options.R

@@ -44,7 +44,7 @@ run_beast2_from_options <- function(
   # Create the folders needed
   ##############################################################################
 
-  beastier::create_beautier_tempfolder()
+  beautier::create_beautier_tempfolder()
   beastier::create_beastier_tempfolder()
   beastier::create_beast2_input_file_folder(beast2_options)
   beastier::create_beast2_state_output_file_folder(beast2_options)

tests/testthat/test-create_beautier_tempfolder.R

@@ -1,12 +1,6 @@
-test_that("use", {
-  check_empty_beaustier_folders()
-
-  folder_name <- dirname(beautier::get_beautier_tempfilename())
-  unlink(folder_name, recursive = TRUE)
-  expect_false(dir.exists(folder_name))
-  beastier::create_beautier_tempfolder()
-  expect_true(dir.exists(folder_name))
-
-  remove_beaustier_folders()
-  check_empty_beaustier_folders()
+test_that("deprecated", {
+  expect_error(
+    beastier::create_beautier_tempfolder(),
+    "deprecated"
+  )
 })

tests/testthat/test-remove_beautier_folder.R

@@ -0,0 +1,6 @@
+test_that("deprecated", {
+  expect_error(
+    beastier::remove_beautier_folder(),
+    "deprecated"
+  )
+})