{smcl}
{* 2004-12-06}{...}
{hline}
help for {hi:povertybeta}{right:(Van Kerm , Philippe)}
{hline}

{title:Computing poverty indices}

{p 8 17 2}[{cmd:by} {it:varlist}:] {cmd:povertybeta} {it:varname} 
[{cmd:if} {it:exp}]
[{cmd:in} {it:exp}]
[{it:weight}]
{break}[{cmd:,} 
{cmd:line(}{it:string}{cmd:)}
{cmd:fracmean(}{it:real}{cmd:)}
{cmd:fracmedian(}{it:real}{cmd:)}
{cmd:gen(}{it:name}{cmd:)}
{cmd:gengap(}{it:name}{cmd:)}
{cmd:gengapratio(}{it:name}{cmd:)}
{cmd:format(}{it:string}{cmd:)}
{cmd:rescale(}{it:real}{cmd:)}
{cmd:fgt(}{it:numlist}{cmd:)}
{cmd:chua(}{it:numlist}{cmd:)}
{cmd:chub(}{it:numlist}{cmd:)}
{cmd:	other_individual_indices}
]

{p 4}(Weights allowed:{space 2}{cmd:aw}{space 2}{cmd:fw}){p_end}


{title:Description}

{p 4 4 2} {cmd:poverty} computes a series of poverty measures from an 
(income) variable. 


{title:Options}

{p 4 8 2}{cmd:line(}{it:string}{cmd:)}{space 1}is the first way of specifying the poverty line. 
 {it:string} can be an existing numeric variable that contains
the value of the poverty for each observation. Alternatively, it can
be a scalar value taken as the poverty line for all observations.
{p_end}

{p 4 8 2}{cmd:fracmean(fraction)}{space 1} {cmd:fracmedian(fraction)}{space 1}provide the second way of specifying the poverty line. The poverty line
is fixed at {it:fraction} times the median of {cmd:varname} (for {cmd:fracmedian)} 
or at {it:fraction} times the mean of {cmd:varname} (for {cmd:fracmean)}. 
 {cmd:fracmedian}, {cmd:fracmean}, and {cmd:line}, are mutually exclusive.
{p_end}

{p 4 8 2}{cmd:gen(newvarname)}{space 1} {cmd:gengap(newvarname)}{space 1} {cmd:gengapratio(newvarname)}{space 1}request that a new variable be created with a 0/1 poverty indicator ( {cmd:gen)}, 
with individual poverty gaps "z-y" ( {cmd:gengap)}, or with individual poverty
gap ratios "1-(y/z)" ( {cmd:gengapratio)}. These options can not be used with
a {cmd:by} prefix. 
{p_end}

{p 4 8 2}{cmd:format(}{it:string}{cmd:)}{space 1}selects a display format for formatting results.
{p_end}

{p 4 8 2}{cmd:rescale(factor)}{space 1}requests that all reported indices are rescaled by a factor {cmd:factor}. To improve
readability, by default, all indices reported are rescaled by a factor 100 (i.e. values are reported 
in percentage). 
{p_end}

{p 4 8 2}{cmd:headcount}{space 1}requests that the headcount ratio (a.k.a. poverty rate or FGT(0)) be calculated and reported.
{p_end}

{p 4 8 2}{cmd:fgt(}{it:numlist}{cmd:)}{space 1}requests that the Foster-Greer-Thorbecke indices are computed for the sensitivity parameters in {cmd:numlist}. 
{p_end}

{p 4 8 2}{cmd:watts}{space 1} {cmd:sen}{space 1} {cmd:sst}{space 1} {cmd:takayama}{space 1}request that the indices by Watts, Sen, Sen-Shorrocks-Thon and/or Takayama be computed.
{p_end}

{p 4 8 2}{cmd:apg}{space 1}requests that the aggregate poverty gap be reported.
{p_end}

{p 4 8 2}{cmd:pgr}{space 1}requests that the average poverty gap ratio be reported (a.k.a. FGT(1)).
{p_end}

{p 4 8 2}{cmd:igrp}{space 1}requests that the average income gap ratio among the poor be reported.
{p_end}

{p 4 8 2}{cmd:medigrp}{space 1}requests that the median income gap ratio among the poor be reported.
{p_end}

{p 4 8 2}{cmd:chua(}{it:numlist}{cmd:)}{space 1}requests that the Clark-Hemming-Ulph indices (family 1) are computed for the sensitivity parameters in {cmd:numlist}. 
{p_end}

{p 4 8 2}{cmd:chub(}{it:numlist}{cmd:)}{space 1}requests that the Clark-Hemming-Ulph indices (family 2) are computed for the sensitivity parameters in {cmd:numlist}. 
--edes--
{p_end}


{title:Examples}

{p 4 8 2}{cmd:.  povertybeta income}{p_end}
{p 4 8 2}{cmd:.  povertybeta income [aw=wght]}{p_end}
{p 4 8 2}{cmd:.  povertybeta income  , fgt(0(1)4)}{p_end}
{p 4 8 2}{cmd:.  povertybeta income  , fgt(0(1)4) sst sen}{p_end}
{p 4 8 2}{cmd:.  povertybeta income  , line(1000)}{p_end}
{p 4 8 2}{cmd:.  povertybeta income  , line(varline)}{p_end}
{p 4 8 2}{cmd:.  povertybeta income  , fracmedian(0.6)}{p_end}
{p 4 8 2}{cmd:.  povertybeta income  , fracmean(0.5)}{p_end}
{p 4 8 2}{cmd:.  povertybeta income  , gen(poor) gengap(povertyga) gengapratio(povertygapratio)}{p_end}
{p 4 8 2}{cmd:.  by gender : povertybeta income  , line(1000)}{p_end}
{p 4 8 2}{cmd:.  by gender : povertybeta income  , fracmean(0.5)}{p_end}


{title:Also see}

{p 13 2}Manual: 
{hi:[R] lorenz}{space 2}
{p_end}
{p 4 13 2}On-line: 
{help summarize}{space 2}
{p_end}
{p 4 13 2}On-line (if installed): 
{help povdeco}{space 2}
{help sepov}{space 2}
{help glcurve}{space 2}
{help sumdist}{space 2}
{p_end}

{title:Author(s)}

{p 4 4 2}Philippe Van Kerm{p_end}
{p 4 4 2}CEPS/INSTEAD, Differdange, G.-D. Luxembourg{p_end}
