safeframe: Generic Data Tagging and Validating

safeframe provides functions to tag and validate data of any kind. safeframe is an abstraction of linelist, which originally applied these principles to epidemiological linelist data. The original proposal for this package can be found on the Discussion board.

Installation

You can install safeframe from CRAN (release) or GitHub (development):

# CRAN
install.packages('safeframe')

# Development
# install.packages("pak")
pak::pak("epiverse-trace/safeframe")

Getting started

library(safeframe)

# Create a safeframe object
x <- make_safeframe(cars, mph = "speed", distance = "dist")

# Validate the tagged data are of a specific type
validate_safeframe(x,
  mph = 'numeric',        # speed should be numeric
  # type() is a helper function of related classes
  distance = type('numeric')    # dist should be numeric, integer
)

Development

Lifecycle

This package is currently maturing, as defined by the RECON software lifecycle:

Package is functional, documented and tested. Can be used in production with the understanding that the interface may still undergo minor changes. Typically semantic version < 1.0.0.

Contributions

Contributions are welcome via pull requests. Anything bigger than a typo fix or a small documentation update should be discussed in an issue first. If you want to report a bug or suggest an enhancement, please open an issue. 😊 See also the general Epiverse-TRACE contribution document.

Common issues

To make it easier for us to evaluate your contribution, please run the following commands before submitting a pull request to ensure your code is consistent with the rest of the package:

styler::style_pkg()
devtools::document()
spelling::update_wordlist(pkg = ".", vignettes = TRUE)

lintr::lint_package()

devtools::test()
devtools::check()

This will reduce the time it takes for us to review your contribution. Thank you! 😊

This project is related to other existing projects in R or other languages, but also differs from them in the following aspects:

labelled: A package for tagging data in R, but it is more focused on tagging variables than validating them.
linelist: A package for managing and validating linelist data - the original inspiration for safeframe.
struct: A package that “provides ways to modify objects more strictly, guaranteeing that we keep the type of the modified element.”

Code of Conduct

Please note that the safeframe project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.