stw_dict: Create new data-dictionary object

Description Usage Arguments Value

View source: R/stw_dict.R

Description

Create new data-dictionary object

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
stw_dict(...)

## Default S3 method:
stw_dict(...)

## S3 method for class ''NULL''
stw_dict(data_dict, ...)

## S3 method for class 'character'
stw_dict(name, type, description, levels = NULL, ...)

## S3 method for class 'data.frame'
stw_dict(data_dict, ...)

## S3 method for class 'stw_meta'
stw_dict(meta, ...)

## S3 method for class 'stw_dataset'
stw_dict(dataset, ...)

Arguments

...

additional args (not used)

data_dict

data.frame that has columns name, type, description

name

character name of the dataset

type

character, type of the variable, see Details

description

character, description of the varaible

levels

character, if type is "factor", the levels of the factor

meta

Object with S3 class stw_meta, contains meta-data

dataset

Object with S3 class stw_dataset, a data frame with attached meta-data

Value

object with S3 class stw_dict


uncoast-unconf/steward documentation built on Jan. 7, 2021, 10:38 a.m.