From bcfbb3cce391112af9adac98ebd56fb351440100 Mon Sep 17 00:00:00 2001 From: Martin Indra Date: Mon, 24 Jul 2023 10:34:20 +0200 Subject: [PATCH 1/2] docs: Improve README.md - Make the language more inclusive & other improvements. - Break lines at < 80 characters. - Add empty lines between titles and other blocks. - Capitalize headings - Link Jupitext --- README.md | 40 ++++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c9cd600..c0c3c56 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,25 @@ # 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 obtains 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 @@ -25,19 +27,29 @@ See the notebook `api-example.md` for usage examples. 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 ``` From b30254ac2cfba0fe7959e3ed0fbcb4caaf188fca Mon Sep 17 00:00:00 2001 From: Martin Indra Date: Mon, 24 Jul 2023 15:23:03 +0200 Subject: [PATCH 2/2] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0c3c56..bcf8d13 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Edvart Exploratory Data Analysis (EDA) is the initial task a data scientist or data -analyst undertakes when they obtains new data. EDA refers to the critical +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.