safeframe (version 1.0.0)

safeframe-package: Base Tools for Tagging and Validating Data

Description

The safeframe package provides tools to help tag and validate data. The 'safeframe' class adds column level attributes to a 'data.frame'. Once tagged, variables can be seamlessly used in downstream analyses, making data pipelines more robust and reliable.

Main functions

• make_safeframe(): to create safeframe objects from a data.frame or a tibble

• set_tags(): to change or add tagged variables in a safeframe

• tags(): to get the list of tags of a safeframe

• tags_df(): to get a data.frame of all tagged variables

• lost_tags_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 tagged variables are lost

Dedicated methods

Specific methods commonly used to handle data.frame are provided for safeframe objects, typically to help flag or prevent actions which could alter or lose tagged variables (and may thus break downstream data pipelines).

• names() <- (and related functions, such as dplyr::rename()) will rename variables and carry forward the existing tags

• x[...] <- and x[[...]] <- (see sub_safeframe): will adopt the desired behaviour when tagged variables are lost

• print(): prints info about the safeframe in addition to the data.frame or tibble

Author

Maintainer: Chris Hartgerink (ORCID)

Other contributors:

• Hugo Gruson (ORCID) [reviewer]

• data.org [copyright holder]

See Also

Useful links:

• https://epiverse-trace.github.io/safeframe/

• https://github.com/epiverse-trace/safeframe

• Report bugs at https://github.com/epiverse-trace/safeframe/issues

Examples

# using base R style
x <- make_safeframe(cars[1:50, ],
  mph = "speed",
  distance = "dist"
)
x

## check tagged variables
tags(x)

## robust renaming
names(x)[1] <- "identifier"
x

## example of dropping tags by mistake - default: warning
x[, 2]

## to silence warnings when tags are dropped
lost_tags_action("none")
x[, 2]

## to trigger errors when tags are dropped
# lost_tags_action("error")
# x[, 1]

## reset default behaviour
lost_tags_action()

# using tidyverse style

## example of creating a safeframe, adding a new variable, and adding a tag
## for it

if (require(dplyr) && require(magrittr)) {
  x <- cars %>%
    tibble() %>%
    make_safeframe(
      mph = "speed",
      distance = "dist"
    ) %>%
    mutate(result = if_else(speed > 50, "fast", "slow")) %>%
    set_tags(ticket = "result")

  head(x)

  ## extract tagged variables
  x %>%
    select(has_tag(c("ticket")))

  ## Retrieve all tags
  x %>%
    tags()

  ## Select based on variable name
  x %>%
    select(starts_with("speed"))
}