Skip to content

Commit

Permalink
docs(README): add link to each section
Browse files Browse the repository at this point in the history
  • Loading branch information
jinglinpeng authored and dovahcrow committed Jan 6, 2021
1 parent 33ed599 commit b687076
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
DataPrep lets you prepare your data using a single library with a few lines of code.

Currently, you can use DataPrep to:
* Collect data from common data sources (through `dataprep.connector`)
* Do your exploratory data analysis (through `dataprep.eda`)
* Clean and standardize data (through `dataprep.clean`)
* Collect data from common data sources (through [`dataprep.connector`](#connector))
* Do your exploratory data analysis (through [`dataprep.eda`](#eda))
* Clean and standardize data (through [`dataprep.clean`](#clean))
* ...more modules are coming

## Releases
Expand Down Expand Up @@ -57,15 +57,8 @@ Currently, you can use DataPrep to:
pip install -U dataprep
```

## Examples & Usages

The following examples can give you an impression of what DataPrep can do:

* [Documentation: Connector](https://sfu-db.github.io/dataprep/user_guide/connector/connector.html)
* [Documentation: EDA](https://sfu-db.github.io/dataprep/user_guide/eda/introduction.html)
* [Documentation: Clean](https://sfu-db.github.io/dataprep/user_guide/clean/introduction.html)

### Connector
## Connector

Connector is an intuitive, open-source API wrapper that speeds up development by standardizing calls to multiple APIs as a simple workflow.

Expand Down Expand Up @@ -110,7 +103,7 @@ If you want to connect with a different web API, Connector is designed to be eas
In the following link, you can see detailed examples of how to use Connector for retrieving data from DBLP, Spotify, Yelp, and other sites, without taking an in-depth look into the web APIs documentation!: [Examples.](https://github.com/sfu-db/dataprep/tree/develop/examples)


### EDA
## EDA
DataPrep.EDA is the fastest and the easiest EDA (Exploratory Data Analysis) tool in Python. It allows you to understand a Pandas/Dask DataFrame with a few lines of code in seconds.

#### Create Profile Reports, Fast
Expand Down Expand Up @@ -146,7 +139,7 @@ Check [plot](https://sfu-db.github.io/dataprep/user_guide/eda/plot.html), [plot_



### Clean
## Clean

DataPrep.Clean contains simple functions designed for cleaning and standardizing a column in a DataFrame. It provides
* A unified API: each function follows the syntax `clean_{type}(df, "column name")` (see an example below)
Expand Down Expand Up @@ -184,6 +177,16 @@ Below are the supported semantic types (more are currently being developed).

For more information, refer to the [User Guide](https://sfu-db.github.io/dataprep/user_guide/clean/introduction.html).


## Documentation

The following documentation can give you an impression of what DataPrep can do:

* [Connector](https://sfu-db.github.io/dataprep/user_guide/connector/connector.html)
* [EDA](https://sfu-db.github.io/dataprep/user_guide/eda/introduction.html)
* [Clean](https://sfu-db.github.io/dataprep/user_guide/clean/introduction.html)


## Contribute

There are many ways to contribute to DataPrep.
Expand Down

0 comments on commit b687076

Please sign in to comment.