Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve introduction #89

Merged
merged 5 commits into from
Sep 6, 2023
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
# Edvart

Exploratory Data Analysis (EDA) is the initial task a data scientist or data
analyst undertakes when they obtain new data. EDA refers to the critical
process of conducting preliminary investigations on data to uncover patterns,
spot anomalies, test hypotheses, and verify assumptions with the help of
summary statistics and graphical representations.
Edvart is an open-source Python library designed to simplify and streamline
your exploratory data analysis (EDA) process.

The Effective Data Visualization and Reporting Tool (Edvart for short) is a
tool that generates a report in the form of a Jupyter notebook, containing
various analyses of the input data.
## Key features
* **One-line Reports**: Generate a comprehensive set of pandas DataFrame
visualizations using a single Python statement.
Edvart supports:
- Data overview,
- Univariate analysis,
- Bivariate analysis,
- Multivariate analysis,
- Grouped analysis
- Time series analysis.
* **Customizable Reports**: Produce, iterate, and style detailed reports
in Jupyter notebooks and HTML formats.
* **Flexible API**: From high-level simplicity in a single line of code
to detailed control, choose the API level that fits your needs.
* **Interactive Visualizations**: Many of the visualizations are interactive
and can be used to explore the data in detail.

## Installation

Expand All @@ -20,6 +30,23 @@ pip install edvart

## Usage

### Creating a default report

```python
import edvart

# Load a dataset to a pandas DataFrame
dataset = edvart.example_datasets.dataset_titanic()
# Create a default report
report = edvart.DefaultReport(dataset)
# Show the report in the current Jupyter notebook
report.show()
# Export the report to an HTML file
report.export_html("report.html")
# Export the code generating the report to a Jupyter notebook
report.export_notebook("report.ipynb")
```

See the notebook [api-example.ipynb](api-example.ipynb) for usage examples.

## User documentation
Expand Down