dtable_guide: Description guide

In renlund/descripteur: Describe Data Sets

Description guide

Description

Determine how to describe a data frame

Usage

dtable_guide(
  data,
  elim.set = NULL,
  catg.tol = 20,
  real.tol = 5,
  as.is = FALSE,
  no.bnry = FALSE,
  reduce.levels = TRUE,
  row.id = NULL,
  unit.id = NULL
)

Arguments

data	a data frame
elim.set	names of variables to exclude from description
catg.tol	only describe categorical data with no more than this many unique values
real.tol	force numeric data with few (<= real.tol) unique data points to be described as categorical
as.is	if TRUE ignore all tolerance parameters
no.bnry	if TRUE, there will be no distinction between 'bnry' and 'catg', they will all be 'catg' (default FALSE)
reduce.levels	if TRUE, empty levels will be removed
row.id	the row identifier, does not really do much at this point
unit.id	the unit identifier, this can later provide information on how many unique units there are in a table or subgroups thereof

Value

a data frame describing each variable in the data set (excluding elim.set, id, and unit.id). each variable has

• typethis decides how other descripteur functions handles the variables

• imposed_classthis is the class we impose

• original_classwhat the variable was

• has_missingis there missing in the data frame for this variable

The return object will also hold some information on id-variables and factorial levels within its attributes

renlund/descripteur documentation built on Sept. 24, 2023, 7:07 p.m.