dataframeexplorer (version 1.0.2)

percentiles_table: Generate percentiles for entire dataframe

Description

This function generates percentiles for all numeric columns in the dataframe. This will come handy while understanding the distribution of data and in outlier treatment.

Usage

percentiles_table(
  dataset,
  output_filename = "",
  percentiles = c(0:10, seq(10, 90, 10), seq(25, 75, 25), 91:100),
  format_width = TRUE,
  sd_required = TRUE,
  min_required = TRUE,
  max_required = TRUE,
  mean_required = TRUE,
  missing_percentage_required = TRUE,
  class_required = TRUE
)

Arguments

dataset

A data.frame

output_filename

Name of the output excel file (should end in ".xlsx") Strongly advised to pass this parameter, else the function's default is "percentiles_table_<system_time>.xlsx"

percentiles

numeric vector of probabilities with values in [0,100]

format_width

Boolean input indicating if output excel cells' column width need to be formatted to "auto"

sd_required

Boolean input indicating if standard deviation column needs to be present in output excel

min_required

Boolean input indicating if minimum column needs to be present in output excel

max_required

Boolean input indicating if maximum column needs to be present in output excel

mean_required

Boolean input indicating if mean column needs to be present in output excel

missing_percentage_required

Boolean input indicating if missing percentage column needs to be present in output excel

class_required

Boolean input indicating if datatype column should be the last column in output excel

Value

Does not return to calling function, writes to file system rather

Examples

# NOT RUN {
percentiles_table(mtcars, output_filename = "percentiles_table_mtcars.xlsx")
percentiles_table(iris, output_filename = "C/Users/Desktop/percentiles_table_iris.xlsx")
# }