Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MDSH14 authored Nov 5, 2021
1 parent 72932f2 commit de8cd62
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Engezny
***Engezny*** is a python package that quickly generates all possible charts from your dataframe and save them for you, and engezny is only supporting now uniparameter visualization using the pie, bar and barh visualizations.

## New release features:
1. Full control with colors used in charts.
2. Arabic issues solved.
4. Base of data control.
5. Issues solved with saving charts.
6. New list of options which make your customization easier (Check them in parameters).

## Advanteges
1. Totally supports Arabic Language.
2. Handles multi-parameters columns and separates them by a comma.
Expand All @@ -24,11 +31,17 @@ Egz.visualize()
```

## Visualization Parameters
- The start column index: `start (int) default = 0`
- Default Value: 0
- The end column index: `end (int) default= -1`
- Default Value: -1
- The file location to save charts in: `location = 'Charts/'`
- Default Value: 'Charts/'
- The extention of the created charts: `extention = 'jpg'`
- Default Value: 'jpg'
- `start (int) default = 0`: The first column to start with index
- `end (int) default = None`: The final column to end with index
- `location (str) default ='Charts/'`: The file location to save charts in. The package creates the file if not exsist
- `extention (str) default = 'jpg'`: The extention of the created charts
- `colors (list) default = None`: A list of colors HEX codes to use in charts
- `save (bool) default = True`: The save option to save generated charts to the local machine
- `multi_sep (str) default = None`: the separator delimiter for multiselection columns
- `single_sep (str) default = None`: A delimiter to split single values with
- `figsize (tuple) default = (15, 15)`: The figure size of charts
- `base (str) default = 'total_values'`: The base to use in charts. Makes a difference with multiselection columns and has three available options:
- `'total_values'`: Uses the sum of total values as a base
- `'data_base'`: Uses the total number of rows in data as a base
- `'column_base'`: Uses the count of non-null cells in the column as a base
- `other (bool) default = False` The other option takes only the top 4 values and combine the rest in and other value

0 comments on commit de8cd62

Please sign in to comment.