check_data: Checks the Dataset and sets attributes on it for use in...

Description Usage Arguments Value Examples

View source: R/check_data.R

Description

Checks the Dataset and sets attributes on it for use in explore_data

Usage

1
check_data(dataset, covariates = NULL, outcome_var = NULL)

Arguments

dataset
  • dataset

covariates
  • optional. Character vector containing columns to subset dataset to. If NULL, then all columns will be used.

outcome_var
  • optional. Character vector containing columns of outcome. These columns must be factors or characters. If NULL, all categorical variables are used as possible outcomes

Value

data.table with the following attributes: outcome_var (validated outcomes),

Examples

1
2
3
4
5
6
library(ggplot2)
data(diamonds)
diamond_frame <- check_data(diamonds, outcome_var=c("cut"))
attr(diamond_frame, "categoricalVars")
attr(diamond_frame, "numericVars")
attr(diamond_frame, "outcome_var")

laderast/burro documentation built on July 19, 2020, 10:51 p.m.