Merge branch 'master' of https://github.com/ngrion/apode

README.md

@@ -13,38 +13,63 @@
 Apode is a package that contains a set of indicators that are applied in economic analysis. It contains measures of poverty, inequality, polarization, welfare and concentration.
 
 
+
+
 ## Requirements
 You need Python 3.8 to run Apode.
 
+## Code Repository & Issues
+
+https://github.com/ngrion/apode
+
+## Basic Install
+
+Execute
 
-## Installation
-Clone this repo and then inside the local directory execute
+```console
+$ pip install apode
+```
 
-    $ pip install -e .
+## Development Install
+
+
+Clone this repo and install with pip
+
+```console
+$ git clone https://github.com/ngrion/apode.git
+$ cd pycf3
+$ pip install -e .
+```
 
 
 ## Features
 
 Objects are created using:
 
-    ad = ApodeData(DataFrame, income_column)
+```python
+>>> ad = ApodeData(DataFrame, income_column)
+```
 
 Where income_column is the name of the desired analysis column in the dataframe.
 
 Methods that calculate indicators:
-
-    ad.poverty(method,*args)    
-    ad.ineq(method,*args)
-    ad.welfare(method,*args) 
-    ad.polarization(method,*args)
-    ad.concentration(method,*args)
+
+```python
+>>> ad.poverty(method,*args)    
+>>> ad.ineq(method,*args)
+>>> ad.welfare(method,*args) 
+>>> ad.polarization(method,*args)
+>>> ad.concentration(method,*args)
+```
 
 Graphical representations:
 
-    ad.plot.hist()
-    ad.plot.tip(**kwargs)
-    ad.plot.lorenz(**kwargs)
-    ad.plot.pen(**kwargs)
+```python
+>>> ad.plot.hist()
+>>> ad.plot.tip(**kwargs)
+>>> ad.plot.lorenz(**kwargs)
+>>> ad.plot.pen(**kwargs)
+```
 
 For examples on how to use apode, please refer to the [Tutorial](https://apode.readthedocs.io/en/latest/Tutorial.html).
 

apode/basic.py

@@ -23,7 +23,7 @@
 
 from .concentration import ConcentrationMeasures
 from .inequality import InequalityMeasures
-from .plots import PlotAccsessor
+from .plots import PlotAccessor
 from .polarization import PolarizationMeasures
 from .poverty import PovertyMeasures
 from .welfare import WelfareMeasures
@@ -79,7 +79,7 @@ class ApodeData:
         init=False, default=attr.Factory(WelfareMeasures, takes_self=True)
     )
     plot = attr.ib(
-        init=False, default=attr.Factory(PlotAccsessor, takes_self=True)
+        init=False, default=attr.Factory(PlotAccessor, takes_self=True)
     )
 
     @income_column.validator

apode/plots.py

@@ -38,7 +38,7 @@
 
 
 @attr.s(frozen=True)
-class PlotAccsessor:
+class PlotAccessor:
     """Plots for Apode.
 
     The following plots are implemented: