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 README.md #3

Merged
merged 2 commits into from
Jul 24, 2023
Merged
Changes from all 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
40 changes: 26 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,55 @@
# Edvart

Exploratory Data Analysis (EDA) is a very initial task a data scientist
or data analyst does when he reaches new data.
EDA refers to the critical process of performing
initial investigations on data to discover patterns, to spot
anomalies, to test hypothesis and to check assumptions with the help
of summary statistics and graphical representations.
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.

Effective data visualization and reporting tool (edvart for short) is a tool that
generates a report in the form of a Jupyter notebook that contains various
analyses of the data passed in.
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.

## Installation

Edvart is available on PyPI and can be installed using pip:

```bash
pip install edvart
```

## Usage

See the notebook `api-example.md` for usage examples.

## User documentation

The user documentation is available at https://datamole-ai.github.io/edvart/.

## License
edvart is licensed under the [MIT license](https://opensource.org/license/mit/). See the LICENSE file for more details.

## How to contribute
Edvart is licensed under the [MIT
license](https://opensource.org/license/mit/). See the LICENSE file for more
details.

## How to Contribute

See [CONTRIBUTING.md](CONTRIBUTING.md).

## Markdown notebooks
Jupyter notebooks are stored in markdown format in the repository. To convert a Markdown notebook to a Jupyter notebook, use `jupytext`. `jupytext` is included in the development dependencies of this project.
For example convert `api-example.md` to `ipynb` Jupyter notebook format:
## Markdown Notebooks

Jupyter notebooks are stored in markdown format in the repository. To convert a
Markdown notebook to a Jupyter notebook, use
[jupytext](https://github.com/mwouts/jupytext). `jupytext` is included in the
development dependencies of this project. For example convert `api-example.md`
to `ipynb` Jupyter notebook format:

```bash
jupytext --to ipynb api-example.md
```

To convert an `ipynb` notebook to markdown:

```bash
jupytext --to md api-example.ipynb
```