Replace lost_tags_action.R with lost_labels_action.R

Updating to the **datatagr** package for handling the lost action.
Also reexporting for ease of use for the user.

Author: chartgerink

R/linelist-package.R

@@ -21,11 +21,11 @@
 #'
 #'   * [labels_df()]: to get a `data.frame` of all tagged variables
 #'
-#'   * [lost_tags_action()]: to change the behaviour of actions where tagged
+#'   * [lost_labels_action()]: to change the behaviour of actions where tagged
 #'   variables are lost (e.g. removing columns storing tagged variables) to
 #'   issue warnings, errors, or do nothing
 #'
-#'   * [get_lost_tags_action()]: to check the current behaviour of actions where
+#'   * [get_lost_labels_action()]: to check the current behaviour of actions where
 #'   tagged variables are lost
 #'
 #' @section Dedicated methods:
@@ -72,15 +72,15 @@
 #'   x[, 2:5]
 #'
 #'   ## to silence warnings when taggs are dropped
-#'   lost_tags_action("none")
+#'   lost_labels_action("none")
 #'   x[, 2:5]
 #'
 #'   ## to trigger errors when taggs are dropped
-#'   # lost_tags_action("error")
+#'   # lost_labels_action("error")
 #'   # x[, 2:5]
 #'
 #'   ## reset default behaviour
-#'   lost_tags_action()
+#'   lost_labels_action()
 #'
 #'
 #'   # using tidyverse style

R/lost_labels_action.R

@@ -0,0 +1,7 @@
+#' @importFrom datatagr lost_labels_action
+#' @export
+datatagr::lost_labels_action
+
+#' @importFrom datatagr get_lost_labels_action
+#' @export
+datatagr::get_lost_labels_action

R/lost_tags_action.R

@@ -3,7 +3,7 @@
 #' The `[]` and `[[]]` operators for `linelist` objects behaves like for regular
 #' `data.frame` or `tibble`, but check that tagged variables are not lost, and
 #' takes the appropriate action if this is the case (warning, error, or ignore,
-#' depending on the general option set via [lost_tags_action()]) .
+#' depending on the general option set via [lost_labels_action()]) .
 #'
 #' @inheritParams base::Extract
 #' @param x a `linelist` object
@@ -19,9 +19,9 @@
 #' @return If no drop is happening, a `linelist`. Otherwise an atomic vector.
 #'
 #' @seealso
-#' * [lost_tags_action()] to set the behaviour to adopt when tags are
+#' * [lost_labels_action()] to set the behaviour to adopt when tags are
 #'   lost through subsetting; default is to issue a warning
-#' * [get_lost_tags_action()] to check the current the behaviour
+#' * [get_lost_labels_action()] to check the current the behaviour
 #'
 #' @export
 #'
@@ -70,7 +70,7 @@
   # args, in case we wanted to use them; so declassing the object instead using
   # the datatagr::drop_datatagr() function
 
-  lost_action <- get_lost_tags_action()
+  lost_action <- get_lost_labels_action()
 
   # Handle the corner case where only 1 arg is passed (x[i]) to subset by column
   n_args <- nargs() - !missing(drop)
@@ -105,7 +105,7 @@
 #' @rdname sub_linelist
 
 `[<-.linelist` <- function(x, i, j, value) {
-  lost_action <- get_lost_tags_action()
+  lost_action <- get_lost_labels_action()
   out <- NextMethod()
   old_tags <- labels(x, show_null = TRUE)
   out <- restore_tags(out, old_tags, lost_action)
@@ -117,7 +117,7 @@
 #' @rdname sub_linelist
 
 `[[<-.linelist` <- function(x, i, j, value) {
-  lost_action <- get_lost_tags_action()
+  lost_action <- get_lost_labels_action()
   out <- NextMethod()
   old_tags <- labels(x, show_null = TRUE)
   out <- restore_tags(out, old_tags, lost_action)
@@ -128,7 +128,7 @@
 #'
 #' @rdname sub_linelist
 `$<-.linelist` <- function(x, name, value) {
-  lost_action <- get_lost_tags_action()
+  lost_action <- get_lost_labels_action()
   out <- NextMethod()
   old_tags <- labels(x, show_null = TRUE)
   out <- restore_tags(out, old_tags, lost_action)

R/square_bracket.R

@@ -1,3 +1,3 @@
 .onLoad <- function(libname, pkgname) {
-  lost_tags_action(Sys.getenv("LINELIST_LOST_ACTION", "warning"), quiet = TRUE)
+  lost_labels_action(Sys.getenv("LINELIST_LOST_ACTION", "warning"), quiet = TRUE)
 }

R/zzz.R

@@ -1,17 +1,17 @@
 test_that("tests for [ operator", {
   x <- make_linelist(cars, id = "speed", age = "dist")
-  on.exit(lost_tags_action())
+  on.exit(lost_labels_action())
 
   # errors
-  lost_tags_action("warning", quiet = TRUE)
+  lost_labels_action("warning", quiet = TRUE)
   msg <- "The following tags have lost their variable:\n age:dist"
   expect_warning(x[, 1], msg)
 
-  lost_tags_action("error", quiet = TRUE)
+  lost_labels_action("error", quiet = TRUE)
   msg <- "The following tags have lost their variable:\n age:dist"
   expect_error(x[, 1], msg)
 
-  lost_tags_action("warning", quiet = TRUE)
+  lost_labels_action("warning", quiet = TRUE)
   msg <- "The following tags have lost their variable:\n id:speed, age:dist"
   expect_warning(x[, NULL], msg)
 
@@ -21,7 +21,7 @@ test_that("tests for [ operator", {
   expect_null(ncol(x[, 1, drop = TRUE]))
   expect_identical(x[, 1, drop = TRUE], cars[, 1])
 
-  lost_tags_action("none", quiet = TRUE)
+  lost_labels_action("none", quiet = TRUE)
   expect_identical(x[, 1], make_linelist(cars[, 1, drop = FALSE], id = "speed"))
 
   # [ behaves exactly as in the simple data.frame case, including when subset
@@ -53,15 +53,15 @@ test_that("tests for [ operator", {
 })
 
 test_that("tests for [<- operator", {
-  on.exit(lost_tags_action())
+  on.exit(lost_labels_action())
 
   # errors
-  lost_tags_action("warning", quiet = TRUE)
+  lost_labels_action("warning", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   msg <- "The following tags have lost their variable:\n id:speed"
   expect_warning(x[, 1] <- NULL, msg)
 
-  lost_tags_action("error", quiet = TRUE)
+  lost_labels_action("error", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   msg <- "The following tags have lost their variable:\n id:speed"
   expect_error(x[, 1] <- NULL, msg)
@@ -70,22 +70,22 @@ test_that("tests for [<- operator", {
   x[1:3, 1] <- 1L
   expect_identical(x$speed[1:3], rep(1, 3))
 
-  lost_tags_action("none", quiet = TRUE)
+  lost_labels_action("none", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   x[, 1:2] <- NULL
   expect_identical(ncol(x), 0L)
 })
 
 test_that("tests for [[<- operator", {
-  on.exit(lost_tags_action())
+  on.exit(lost_labels_action())
 
   # errors
-  lost_tags_action("warning", quiet = TRUE)
+  lost_labels_action("warning", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   msg <- "The following tags have lost their variable:\n id:speed"
   expect_warning(x[[1]] <- NULL, msg)
 
-  lost_tags_action("error", quiet = TRUE)
+  lost_labels_action("error", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   msg <- "The following tags have lost their variable:\n id:speed"
   expect_error(x[[1]] <- NULL, msg)
@@ -94,28 +94,28 @@ test_that("tests for [[<- operator", {
   x[[1]] <- 1L
   expect_identical(x$speed, rep(1L, nrow(x)))
 
-  lost_tags_action("none", quiet = TRUE)
+  lost_labels_action("none", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   x[[2]] <- NULL
   x[[1]] <- NULL
   expect_identical(ncol(x), 0L)
 })
 
 test_that("$<- operator detects tag loss", {
-  on.exit(lost_tags_action())
+  on.exit(lost_labels_action())
 
   # errors
-  lost_tags_action("warning", quiet = TRUE)
+  lost_labels_action("warning", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   msg <- "The following tags have lost their variable:\n id:speed"
   expect_warning(x$speed <- NULL, msg)
 
-  lost_tags_action("error", quiet = TRUE)
+  lost_labels_action("error", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   msg <- "The following tags have lost their variable:\n id:speed"
   expect_error(x$speed <- NULL, msg)
 
-  lost_tags_action("none", quiet = TRUE)
+  lost_labels_action("none", quiet = TRUE)
   x <- make_linelist(cars, id = "speed", age = "dist")
   x$speed <- NULL
   x$dist <- NULL

tests/testthat/test-lost_tags_action.R

@@ -5,19 +5,19 @@ test_that("tests for zzz", {
   res <- callr::r(
     function() {
       library(linelist)
-      get_lost_tags_action()
+      get_lost_labels_action()
     }
   )
   expect_identical(res, "warning")
 
 })
 
-test_that("Environment variable is used for initial `lost_tags_action`", {
+test_that("Environment variable is used for initial `lost_labels_action`", {
   # We need to use callr to avoid conflicts with other tests
   res <- callr::r(
     function() {
       library(linelist)
-      get_lost_tags_action()
+      get_lost_labels_action()
     },
     env = c(LINELIST_LOST_ACTION = "error")
   )

tests/testthat/test-square_bracket.R

@@ -91,7 +91,7 @@ x %>%
 During operations on columns, linelist will:
 
 - stay invisible and conserve tags if no tagged column is affected by the operation
-- trigger `lost_tags_action()` if tagged columns are affected by the operation
+- trigger `lost_labels_action()` if tagged columns are affected by the operation
 
 ### `dplyr::mutate()` ✓ (partial)