{"Package":"safeframe","Title":"Generic Data Tagging and Validation Tool","Version":"1.0.0","Authors@R":"c(\nperson(\"Chris\", \"Hartgerink\", , \"chris@data.org\", role = c(\"cre\", \"aut\"),\ncomment = c(ORCID = \"0000-0003-1050-6809\")),\nperson(\"Hugo\", \"Gruson\", , \"hugo@data.org\", role = \"rev\",\ncomment = c(ORCID = \"0000-0002-4094-1476\")),\nperson(\"data.org\", role = \"cph\")\n)","Description":"Provides tools to help tag and validate data according to user-specified rules. The 'safeframe' class adds variable level attributes to 'data.frame' columns. Once tagged, these variables can be seamlessly used in downstream analyses, making data pipelines clearer, more robust, and more reliable.","License":"MIT + file LICENSE","URL":"https://epiverse-trace.github.io/safeframe/,\nhttps://github.com/epiverse-trace/safeframe","BugReports":"https://github.com/epiverse-trace/safeframe/issues","Depends":"R (>= 4.1.0)","Imports":"checkmate, lifecycle, rlang, tidyselect","Suggests":"callr, dplyr, knitr, magrittr, rmarkdown, spelling, testthat,\ntibble","Config/Needs/website":"r-lib/pkgdown, epiverse-trace/epiversetheme","VignetteBuilder":"knitr","Config/testthat/edition":"3","Config/testthat/parallel":"true","Encoding":"UTF-8","Language":"en-GB","RoxygenNote":"7.3.2","NeedsCompilation":"no","Packaged":"2025-06-24 08:18:01 UTC; chartgerink","Author":"Chris Hartgerink [cre, aut] (ORCID:\n),\nHugo Gruson [rev] (ORCID: ),\ndata.org [cph]","Maintainer":"Chris Hartgerink ","Repository":"CRAN","Date/Publication":"2025-06-27 13:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/safeframe_1.0.0.tar.gz","jsonAuthors":[{"name":"Chris Hartgerink","email":"chris@data.org","maintainer":true},{"name":"Hugo Gruson","email":"hugo@data.org","maintainer":false},{"name":"data.org ","email":null,"maintainer":false}],"readme":"\n\n\n\n\n\n\n\n\n\n\n# *safeframe*: Generic Data Tagging and Validating $\"Logo$ \n\n\n\n[![License:\nMIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)\n[![R-CMD-check](https://github.com/epiverse-trace/safeframe/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiverse-trace/safeframe/actions/workflows/R-CMD-check.yaml)\n[![Codecov test\ncoverage](https://codecov.io/gh/epiverse-trace/safeframe/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiverse-trace/safeframe?branch=main)\n[![lifecycle-concept](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-maturing.svg)](https://www.reconverse.org/lifecycle.html#maturing)\n\n\n\n**safeframe** provides functions to tag and validate data of any kind.\nsafeframe is an abstraction of\n[**linelist**](https://github.com/epiverse-trace/linelist), which\noriginally applied these principles to epidemiological linelist data.\nThe original proposal for this package can be found on [the Discussion\nboard](https://github.com/orgs/epiverse-trace/discussions/221).\n\n## Installation\n\nYou can install safeframe from CRAN (release) or GitHub (development):\n\n``` r\n# CRAN\ninstall.packages('safeframe')\n\n# Development\n# install.packages(\"pak\")\npak::pak(\"epiverse-trace/safeframe\")\n```\n\n## Getting started\n\n``` r\nlibrary(safeframe)\n\n# Create a safeframe object\nx <- make_safeframe(cars, mph = \"speed\", distance = \"dist\")\n\n# Validate the tagged data are of a specific type\nvalidate_safeframe(x,\n mph = 'numeric', # speed should be numeric\n # type() is a helper function of related classes\n distance = type('numeric') # dist should be numeric, integer\n)\n```\n\n## Development\n\n### Lifecycle\n\nThis package is currently *maturing*, as defined by the [RECON software\nlifecycle](https://www.reconverse.org/lifecycle.html):\n\n> Package is functional, documented and tested. Can be used in\n> production with the understanding that the interface may still undergo\n> minor changes. Typically semantic version \\< 1.0.0.\n\n### Contributions\n\nContributions are welcome via [pull\nrequests](https://github.com/epiverse-trace/safeframe/pulls). Anything\nbigger than a typo fix or a small documentation update should be\ndiscussed in an issue first. If you want to report a bug or suggest an\nenhancement, please open an issue.

Description

Usage

Value

Arguments

Details

Examples