describe_data: Describe data

View source: R/util_data.R

describe_dataR Documentation

Describe data

Description

Calculate key descriptive statistics for a given set of data.

Usage

describe_data(data, data_name, criterion_name, baseline_value)

Arguments

data

A data frame with a criterion variable criterion_name.

data_name

A character string specifying a name for the data.

criterion_name

A character string specifying the criterion name.

baseline_value

The value in criterion_name denoting the baseline (e.g., TRUE or FALSE).

Value

A data frame with the descriptive statistics.

Examples

data(heartdisease)
describe_data(heartdisease, "heartdisease",
              criterion_name = "diagnosis",
              baseline_value = TRUE)


FFTrees documentation built on June 7, 2023, 5:56 p.m.