---
title: "Getting Started with EDAForge"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Getting Started with EDAForge}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

# Introduction

**EDAForge** is an R package for automated exploratory data analysis (EDA). It provides functions for descriptive statistics, missing value analysis, correlation analysis, visualization, outlier detection and automated reporting.

```{r setup}
library(EDAForge)
```

# Example dataset

This vignette uses the built-in `iris` dataset.

```{r}
data <- iris
head(iris)
```

# Numeric summary

Generate descriptive statistics for all numeric variables.

```{r}
num_sum <- numeric_summary(iris)
head(num_sum)
```

# Missing value summary

Summarize missing values.

```{r}
missing_summary(iris)
```

# Correlation analysis

Compute the correlation matrix for numeric variables.

```{r}
correlation_analysis(iris)
```

# Export numeric summary

Output files in examples and vignettes should always be written to a temporary directory.

```{r}
outfile <- file.path(tempdir(), "NumericSummary.csv")

export_numeric_summary(
  num_sum,
  outfile
)

file.exists(outfile)
```

# Automated EDA

Generate an overall exploratory data analysis.

```{r}
auto_eda(iris)
```

# Session information

```{r}
sessionInfo()
```