var_overview: Generate a basic overview of a dataset.

Description Usage Arguments Details Value Examples

View source: R/var_overview.R

Description

Dynamically generate an overview of a given dataset taking into account variable types.

Usage

1
2
var_overview(data, observation_unit = NA, alternative_id = NA,
  alternative_id_name = "/", data_name = NA)

Arguments

data

data.table for which the overview is to be generated (data.table).

observation_unit

Observation unit (character).

alternative_id

name of column corresponding to the alternative_id_name (character).

alternative_id_name

alternative observation unit, e.g. "patients" in a diagnosis file with multiple diagnoses per patient (character).

data_name

file title (printed at the top of the overview) (character).

Details

Maintained by: Clara Marquardt

Value

Overview of dataset [data.table]

Examples

1
2
summary_dt <- var_overview(dia, alternative_id="empi", alternative_id_name="patients",observation_unit="diagnoses", data_name="dia.rda" )
print(str(summary_dt))

ClaraMarquardt/ehR documentation built on Sept. 17, 2017, 6:05 p.m.