Merge branch 'release/v0.1'

README.md

@@ -1,11 +1,52 @@
-# Living Income Calculation tools
+# 'kit_livingincome': LIVING INCOME CALCULATIONS AND OUTPUTS: stata package to produce tables and charts of the Gap to the Living Income Benchmark
+[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
+
 ## Developed by [KIT](http://www.kit.nl) and [COSA](http://thecosa.org/)
 [Last update 4/5/2020] 
 
-A set of (stata) tools to compute gap towards the Living Income Benchmark and how to present it.
+'kit_livingincome' provides stata ado-file to produce tables and charts of the Gap to the Living Income Benchmark
+
+It produces graphs similar to what can be seen at:
+
+https://www.kit.nl/wp-content/uploads/2019/01/Analysis-of-the-income.pdf
+
+https://docs.wixstatic.com/ugd/0c5ab3_93560a9b816d40c3a28daaa686e972a5.pdf
+
+### Authors
+
+Marcelo Tyszler. KIT Royal Tropical Institute, Netherlands. [email protected]
+
+Carlos de los Rios. COSA. [email protected]
+
+### Requirements
+
+* Stata version 15.1 
+
+### Installing `kit_livingincome`
+
+To install the latest development version directly from Github using stata `github` package, type: 
+```
+net install github, from("https://haghish.github.io/github/") 
+github install mtyszler/KIT_LivingIncome
+```
+
+To install using stata `net` command, type:
+```
+net from https://raw.githubusercontent.com/mtyszler/kit_livingincome/master/
+net install kit_livingincome
+```
+
+### Citation
+
+Please cite the package as follows:
+
+> Tyszler, et al. (2019). Living Income Calculations Toolbox. KIT ROYAL TROPICAL 
+INSTITUTE and COSA. Available at: https://github.com/mtyszler/KIT_LivingIncome/
+
+### License
+[![License: CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/80x15.png)](https://creativecommons.org/licenses/by-sa/4.0/)
 
+This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. 
+To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
 
-### Who do I talk to? ###
 
-* [Marcelo Tyszler, KIT](mailto:[email protected])
-* [Carlos de los Rios, COSA](mailto:[email protected])

kit_livingincome.pkg

@@ -0,0 +1,19 @@
+v 0.1
+d 'kit_livingincome': LIVING INCOME CALCULATIONS AND OUTPUTS: stata package to produce tables and charts of the Gap to the Living Income Benchmark
+d Marcelo Tyszler, PhD, KIT Royal Tropical Institute
+d 
+d These stata ado-file produces tables and charts of the Gap to the Living Income Benchmark
+d 
+d It produces graphs similar to what can be seen at:
+d https://www.kit.nl/wp-content/uploads/2019/01/Analysis-of-the-income.pdf
+d https://docs.wixstatic.com/ugd/0c5ab3_93560a9b816d40c3a28daaa686e972a5.pdf
+d
+d package maintained at:
+d https://github.com/mtyszler/KIT_LivingIncome/
+d 
+d Distribution-Date: 20200505
+d
+F kitli_gap2bm.ado
+F kitli_gap2bm.sthlp
+F kitli_compare2bm.ado
+F kitli_compare2bm.sthlp

KITLI_compare2bm.ado → kitli_compare2bm.ado

@@ -8,9 +8,8 @@ It produces graphs similar to what can be seen at:
 https://www.kit.nl/wp-content/uploads/2019/01/Analysis-of-the-income.pdf
 https://docs.wixstatic.com/ugd/0c5ab3_93560a9b816d40c3a28daaa686e972a5.pdf
 
-
-It assumes variables have already been calculated. 
-If not, please check do-files: KITLI_incomecalculations.ado
+Type
+help kitli_compare2bm for more details
 
 ---------------------------------------------------------------------------
 
@@ -22,8 +21,8 @@ ISEAL, Living Income Community of Practice and GIZ
 
 You are free to use it and modify for your needs. BUT PLEASE CITE US:
 
-Tyszler, et al. (2019). Living Income Calculations Toolbox. KIT ROYAL TROPICAL 
-INSTITUTE and COSA. Available at: https://bitbucket.org/kitimpactteam/living-income-calculations/
+Tyszler, et al. (2020). Living Income Calculations Toolbox. KIT ROYAL TROPICAL 
+INSTITUTE and COSA. Available at: https://github.com/mtyszler/KIT_LivingIncome/
 
 This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. 
 To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
@@ -35,8 +34,8 @@ Last Update:
 *****************************************************************************/
 
 version 15.1 
-capture program drop KITLI_compare2bm
-program define KITLI_compare2bm, sortpreserve
+capture program drop kitli_compare2bm
+program define kitli_compare2bm, sortpreserve
 	syntax varname(numeric) [if] [in], ///
 	hh_income(varname numeric) ///
 	[grouping_var(varname numeric) ///