R/data_docs.R

In JDOsborne1/meta-monster: Generate and use Metadata

## The package documentation

#' Data Dictionary generation and interaction
#'
#' This package contains functions and examples for using and expanding data
#' dictionaries
#' @docType package
#' @name megametadata
#' @aliases meta-monster
NULL

## The dataset documentation


#' Tester Specification
#'
#' An tester specification which can be used to expand or update the initial
#' phase of the data dictionary
#'
#' @format A list of lists with each Level of the data and each class of column
"spec"

#' Example Dict config
#'
#' An example Dictionary which can be used as an example to expand from or as a
#' testing object
#'
#' @format A list of lists with each Level of the data and each class of column
"tester"

#' Example Specification
#'
#' An Exanple specification which can be used to expand or update the initial
#' phase of the data dictionary
#'
#' @format A list of lists with each Level of the data and each class of column
"default_spec"