From 649d20d30bc0e74c5ce9a261d040d9856aefdb6d Mon Sep 17 00:00:00 2001
From: pan1fan2 <panfanubc@gmail.com>
Date: Sat, 6 Mar 2021 22:07:34 +0800
Subject: [PATCH] eda func documentation

---
 R/eda.R | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 R/eda.R

diff --git a/R/eda.R b/R/eda.R
new file mode 100644
index 0000000..baed54e
--- /dev/null
+++ b/R/eda.R
@@ -0,0 +1,18 @@
+#' Run a quick EDA analysis
+#'
+#' @param df dataframe
+#' @param target character
+#'
+#' @return (list) List that contains statistical summaries and a pairplot.
+#' @export
+#'
+#' @examples
+#' result <- eda(mtcars)
+#' nb_num_feat  <- result$nb_num_features
+#' nb_cat_feat <- result$nb_cat_features
+#' ls_cat_feat <- result$cat_features
+#' ls_num_feat <- result$num_features
+#' nb_class<- result$nb_classes
+#' pair_plot <- result$pairplot
+eda <- function(df, target){
+}
\ No newline at end of file