feat: Adds functions enable_suppression() and disable_suppression()

Author: jim-smith

R/acro_init.R

@@ -1,6 +1,6 @@
 # Globals -----------------------------------------------------------------
 acro_venv <- "r-acro"
-acro_pkg <- "acro==0.4.11"
+acro_pkg <- "acro==0.4.12"
 ch <- "conda-forge"
 
 

R/output_commands.R

@@ -98,3 +98,30 @@ acro_finalise <- function(path, ext) {
   }
   acroEnv$ac$finalise(path, ext)
 }
+
+
+#' Turns suppresssion on during a session
+#'
+#' @return No return value, called for side effects
+#' @export
+
+acro_enable_suppression <- function() {
+  if (is.null(acroEnv$ac)) {
+    stop("ACRO has not been initialised. Please first call acro_init().")
+  }
+  acroEnv$ac$enable_suppression()
+}
+
+#' Turns suppresssion off during a session
+#'
+#' @return No return value, called for side effects
+#' @export
+
+acro_disable_suppression <- function() {
+  if (is.null(acroEnv$ac)) {
+    stop("ACRO has not been initialised. Please first call acro_init().")
+  }
+  acroEnv$ac$disable_suppression()
+}
+
+

tests/testthat/test-acro_disable_suppression.R

@@ -0,0 +1,14 @@
+test_that("acro_enable_suppression without initialising ACRO object first", {
+  acroEnv$ac <- NULL
+  expect_error(acro_disable_suppression(), "ACRO has not been initialised. Please first call acro_init()")
+})
+
+test_that("acro_disable_suppression works", {
+  testthat::skip_on_cran()
+  acro_init()
+  foo  <- acro_disable_suppression()
+  table <- acro_crosstab(index = nursery_data[, c("recommend")], columns = nursery_data[, c("parents")])
+  output <- acro_print_outputs()
+  status <- "fail"
+  expect_true(any(grepl(status, output)))
+})

tests/testthat/test-acro_enable_suppression.R

@@ -0,0 +1,14 @@
+test_that("acro_enable_suppression without initialising ACRO object first", {
+  acroEnv$ac <- NULL
+  expect_error(acro_enable_suppression()(), "ACRO has not been initialised. Please first call acro_init()")
+})
+
+test_that("acro_enable_suppression works", {
+  testthat::skip_on_cran()
+  acro_init()
+  acro_enable_suppression()
+  table <- acro_crosstab(index = nursery_data[, c("recommend")], columns = nursery_data[, c("parents")])
+  output <- acro_print_outputs()
+  status <- "review"
+  expect_true(any(grepl(status, output)))
+})

tests/testthat/test-acro_pivot_table.R

@@ -6,8 +6,10 @@ test_that("acro_pivot_table without initialising ACRO object first", {
 test_that("acro_pivot_table works", {
   testthat::skip_on_cran()
   expected_table <- data.frame(
-    "('mean', 'children')" = c(3.272222, 3.242593, 3.241667),
-    "('std', 'children')" = c(2.48458394, 2.43848908, 2.42963966),
+#    "(mean', 'children')" = c(3.272222, 3.242593, 3.241667),
+#    "('std', 'children')" = c(2.48458394, 2.43848908, 2.42963966),
+    "mean children" = c(3.272222, 3.242593, 3.241667),
+    "std   children" = c(2.48458394, 2.43848908, 2.42963966),
     check.names = FALSE
   )
 
@@ -17,6 +19,7 @@ test_that("acro_pivot_table works", {
 
   acro_init()
   table <- acro_pivot_table(data = nursery_data, index = "parents", values = "children", aggfunc = list("mean", "std"))
+  print( table)
   print(expected_table)
   expect_equal(table[, -1, drop = FALSE], expected_table[, -1, drop = FALSE])
 })