dg2pop

Standardisation and decomposition of rates over K rate-factors and 2 populations.
We suggest using dgnpop, which will internally call this function.

Implementation of Das Gupta's standardisation and decomposition of population rates, as set out "Standardization and decomposition of rates: A user’s manual", Das Gupta (1993) <https://www2.census.gov/library/publications/1993/demographics/p23-186.pdf>. The goal of these methods is to calculate adjusted rates based on compositional 'factors' and quantify the contribution of each factor to the difference in crude rates between populations. The package offers functionality to handle various scenarios for any number of factors and populations, where said factors can be comprised of vectors across sub-populations (including cross-classified population breakdowns), and with the option to specify user-defined rate functions.

Josiah King

DasGuptR

Das Gupta Standardisation and Decomposition

Ben Matthews

dg2pop function

<dl><dt>pw</dt>
<dd>dataframe containing two populations worth of factor data, with columns specifying 1) population and 2) each rate-factor to be considered. must have column named "pop" indicating the population ID.</dd>
<dt>pop</dt>
<dd>name (character string) of variable indicating population</dd>
<dt>factors</dt>
<dd>names (character vector) of variables indicating compositional factors</dd>
<dt>id_vars</dt>
<dd>character vector of variables indicating sub-populations</dd>
<dt>ratefunction</dt>
<dd>user defined character string in R syntax that when evaluated specifies the function defining the rate as a function of factors. if NULL then will assume rate is the product of all factors.</dd>
<dt>quietly</dt>
<dd>logical indicating whether interim messages should be outputted indicating progress through the P factors</dd></dl>

Arguments

Standardisation and decomposition of rates over K rate-factors and 2 populations.
We suggest using dgnpop, which will internally call this function. — dg2pop

<dl>

<dt>pw</dt>
<dd>dataframe containing two populations worth of factor data, with columns specifying 1) population and 2) each rate-factor to be considered. must have column named "pop" indicating the population ID.</dd>


<dt>pop</dt>
<dd>name (character string) of variable indicating population</dd>


<dt>factors</dt>
<dd>names (character vector) of variables indicating compositional factors</dd>


<dt>id_vars</dt>
<dd>character vector of variables indicating sub-populations</dd>


<dt>ratefunction</dt>
<dd>user defined character string in R syntax that when evaluated specifies the function defining the rate as a function of factors. if NULL then will assume rate is the product of all factors.</dd>


<dt>quietly</dt>
<dd>logical indicating whether interim messages should be outputted indicating progress through the P factors</dd>

</dl>

dg2pop: Standardisation and decomposition of rates over K rate-factors and 2 populations. We suggest using dgnpop, which will internally call this function.

Description

Usage

Value

Arguments