feat: add setters to toggle suppression during a session (#43)

* feat: Adds  functions enable_suppression() and disable_suppression()

* cleaning code

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* adding files tweaked by rcheck

* updated news

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* adding rhub commands to pre-submission-check

* commented out old version of rhub

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fixing typos and quote levels in markdown

* version should be 1.7

* Remove version 0.1.8 entry from NEWS.md

Signed-off-by: Jim-smith <jim-smith@users.noreply.github.com>

---------

Signed-off-by: Jim-smith <jim-smith@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: jim-smith

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: acro
 Title: A Tool for Semi-Automating the Statistical Disclosure Control of Research Outputs
-Version: 0.1.6
+Version: 0.1.7
 Authors@R: c(
   person("Jim", "Smith", role = c("cre","ctb"),
          email = "James.Smith@uwe.ac.uk", comment = c(ORCID = "0000-0001-7908-1859")),

NAMESPACE

@@ -4,6 +4,8 @@ export(acro_add_comments)
 export(acro_add_exception)
 export(acro_crosstab)
 export(acro_custom_output)
+export(acro_disable_suppression)
+export(acro_enable_suppression)
 export(acro_finalise)
 export(acro_glm)
 export(acro_hist)

NEWS.md

@@ -1,3 +1,16 @@
+
+# acro 0.1.7
+* Added support for installation via conda
+* Added support for specifying config files when acro session is started
+* Added support for specifying whether suppression is on or off when acro session is started
+* Added support for toggling suppression dynamically during session via   `acro_enable_supression()`
+  and `acro_disable_suppression()`
+* Improved documentation in package and at [sacro-tools.org](sacro-tools.org)
+* Added Support for variable names with spaces when calling crosstab
+* Set status of disclosive outputs to 'review' (previously 'fail') when suppression has been applied
+* Automatically add exception message when applying suppression to an output
+* Make `acro_finalise()` non-interactive by default (interactive is now option at call time)
+
 # acro 0.1.6
 
 * Upgrade ACRO Python backend to v0.4.11, supporting Python 3.14.

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,28 @@ acro_finalise <- function(path, ext) {
   }
   acroEnv$ac$finalise(path, ext)
 }
+
+
+#' Turns suppression 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 suppression 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()
+}

inst/WORDLIST

@@ -1,41 +1,38 @@
 ADR
 Acknowledgement
 Analytics
+Conda
 EPSRC
-GPLv
 GRAIMATTER
 HDR
 Initialise
 Karnofsky
 MRC
 MyBinder
-NK
-PyPI
 RStudio
 SACRO
 SDC
-Scalable
-TRE
+TREs
+TREvolution
+Transformative
 Xplore
+YAML
+analytics
 auditable
-btn
 codecov
+conda
+config
 crosstab
 disclosive
-finalise
 github
 https
 initialised
 json
-mitigations
 numpy
 openml
-organisation
 pre
 programme
-sacro
 scipy
-sm
-statsmodels
 www
 xlsx
+yaml

man/acro_disable_suppression.Rd

@@ -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)))
+})

man/acro_enable_suppression.Rd

@@ -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)))
+})