/metaframe

An R package to extend the functionality of data.frame and data.frame-like objects with metadata and codebook annotations.

Primary LanguageRGNU General Public License v2.0GPL-2.0

metaframe

An R package to extend the functionality of data.frame and data.frame-like objects with metadata and codebook annotations.

Introduction

Metadata is not easily accessed and used in R and this is a big challenge to the efforts to make data analysis more automated and more reproducible. This package seeks to create a simple object-type for easily storing, updating, and outputting metadata during the course of an analysis project. This way the codebook can be baked right into the code.

Overview

metaframe is organized around [a meta.data object][1]. This is an S4 object that stores lists of attributes for a data set. The package will also contain a small set of basic functions to package a data.frame and a meta.data object together, while retaining the functionality of a data.frame with some additional enhancements.

Storing Metadata in R

metaframe organizes your meta.data into a few categories -- some of which it can helpfully auto-complete for you.

Example

library(metaframe)
doco <- document(airquality)

[1]: The object is deliberately named with a period, meta.data, to avoid confusion when rendering HTML documents, mimic the formatting of data.frame, and to make searching for this specific implementation of metadata in R easier.