quicksummary: Quick Formatted Summary of Machine Learning Data

In JobNmadu/Dyn4cast: Dynamic Modeling and Machine Learning Environment

Quick Formatted Summary of Machine Learning Data

Description

There is increasing need to make user-friendly and production ready Tables for machine learning data. This function is a simplified quick summary and the output is a formatted table. This is very handy for those who do not have the time to write codes for user-friendly summaries.

Usage

quicksummary(x, Type, Cut, Up, Down, ci = 0.95)

Arguments

x	The data to be summarised. Only numeric data is allowed.
Type	The type of data to be summarised. There are two options here 1 or 2, 1 = Continuous and 2 = Likert-type
Cut	The cut-off point for Likert-type data
Up	The top Likert-type scale, for example, Agree, Constraints etc which would appear in the remark column.
Down	The lower Likert-type scale, for example, Disagree, ⁠Not a Constraint⁠ etc which would appear in the remark column.
ci	Confidence interval which is defaults to 0.95.

Value

The function returns a formatted Table of the Quick summary

ANS	The formatted Table of the summary

Examples

# Likert-type data
Up <- "Constraint"
Down <- "Not a constraint"
quicksummary(x = Quicksummary, Type = 2, Cut = 2.60, Up = Up, Down = Down)

# Continuous data
x <- select(linearsystems, 1:6)
quicksummary(x = x, Type = 1)

JobNmadu/Dyn4cast documentation built on March 5, 2025, 9:56 p.m.