From 82acf41155eeebc4154f4a51abb3267e9a3d5dbe Mon Sep 17 00:00:00 2001
From: giorgiacek <giorgivola@gmail.com>
Date: Wed, 14 Feb 2024 18:06:42 +0000
Subject: [PATCH] Alternatives to povline added

---
 vignettes/md_functions.Rmd | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/vignettes/md_functions.Rmd b/vignettes/md_functions.Rmd
index fe918f7..fecd872 100644
--- a/vignettes/md_functions.Rmd
+++ b/vignettes/md_functions.Rmd
@@ -133,6 +133,25 @@ pip_FGT2 <- pipmd_pov_severity(welfare = pip_md$welfare,
 print(paste0("The poverty severity index is ", round(pip_FGT2$pov_severity*100,2), "%"))
 ```
 
+### 1.4 Alternatives
+For each of the previous poverty indexes functions, the user can specify the `mean` or a factor (`times_mean`) with which the function will calculate the poverty line. For example:
+
+```{r poverty-alternative-1}
+pip_FGT1_alt <- pipmd_pov_gap(welfare = pip_md$welfare,
+                              weight = pip_md$weight,
+                              times_mean = 0.2)
+
+print(paste0("The poverty gap index is ", round(pip_FGT1_alt$pov_gap*100,2), "%"))
+```
+
+Finally, `povline` can also take multiple values:
+```{r poverty-alternative-2}
+pip_FGT1_multiple <- pipmd_pov_gap(welfare = pip_md$welfare,
+                                          weight = pip_md$weight,
+                                          povline = c(1.4, 3, 4))
+
+print(pip_FGT1_multiple)
+```
 
 ## Case 2: Additional Inequality and Poverty Measures
 `pipster` can also be used to easily calculate additional inequality measures.