description: Describe data set

View source: R/description.R

descriptionR Documentation

Describe data set

Description

Generate extensive description of a data set.

Usage

description(data_set, level = 1, path_to_write = NULL, verbose = TRUE)

Arguments

data_set

Matrix, data.frame or data.table

level

Level of description (0: generic, 1: column by column) (numeric, default to 1)

path_to_write

Path where the report should be written (character, default to NULL)

verbose

Should the algorithm talk? (Logical, default to TRUE)

Examples

# Load exemple set
data(tiny_messy_adult)

# Describe it
description(tiny_messy_adult)

dataPreparation documentation built on July 9, 2023, 7:02 p.m.