cleanliness_smry: Create cleanliness summary of dataset

View source: R/cleanliness_smry.R

cleanliness_smryR Documentation

Create cleanliness summary of dataset

Description

Creates a summary of how clean a dataset is.

Usage

cleanliness_smry(data, ignore = c(), outlier_sd = 3, quiet = FALSE)

Arguments

data

dataset to be analysed.

ignore

columns in dataset to be ignored.

outlier_sd

Number of standard deviations away from the mean for a observation to be classified as an outlier. Default is 3.

quiet

print messages to console.

Details

Creates a list of various summaries and plots on how clean a dataset is. The function returns number of; blank observations, NAs, duplicates, outliers as well as number of plots for the mentioned figures. Outliers will only be assessed for numeric columns. If certain columns are to be excluded from this analysis, use the ignore parameter. To prevent messages from printing to the console, set quiet to TRUE (default is FALSE).

Value

a list of various summaries and plots on how the clean the dataset is.

Examples

## Not run: 
if(interactive()){
 data(property_prices)
 cleanliness_smry(property_prices)
 }

## End(Not run)

Nanoputian628/nano documentation built on Oct. 30, 2023, 3:28 p.m.