dataframe_report: dataframe_report

View source: R/dataframe_report.R

dataframe_reportR Documentation

dataframe_report

Description

Function provides a simple report on a dataframe destined to for regression modeling, plotting, or other data investigations.

Function returns a list of dataframes showing rows of outliers, missing data, and types of variables from the target dataframe.

Usage

dataframe_report(df, miss_values = NULL)

Arguments

df

The required target dataframe from which some basic information on observed data can be gathered.

miss_values

An optional vector with numeric and character values that define in addition to NA and NaN, other values considered as missing. Examples might be a vector with "na", "N/A", 999.

Value

Returning a named list with dataframes named:

  1. "missing",

  2. "outliers"

  3. "datatypes"

Examples

library(data.table)
library(RregressPkg)
set.seed(123)
dt <- data.table(
  id = 1:100,
  category = sample(c("A","B","C",NA), 100, replace = TRUE),
  value = c(rnorm(97), -10, 100, NA),
  date = c(seq.Date(from = as.Date("2020-01-01"), by = "day", length.out = 99), NaN),
  text = sample(c("Lorem","Ipsum","Dolor","Sit",NA), 100, replace = TRUE)
)
report_lst <- RregressPkg::dataframe_report(dt)


deandevl/RregressPkg documentation built on Feb. 5, 2025, 12:11 p.m.