anthro_api_compute_prevalence

Provides WHO Child Growth Standards (z-scores) with
confidence intervals and standard errors around the
prevalence estimates, taking into account complex sample designs.
More information on the methods is
available online:
<https://www.who.int/tools/child-growth-standards>.

Dirk Schumacher

anthro

Computation of the WHO Child Growth Standards

Elaine Borghi

Jonathan Polonsky

World Health Organization 

anthro_api_compute_prevalence function

<dl><dt>data</dt>
<dd>a data frame containing the underlying data</dd>
<dt>zscores_to_compute</dt>
<dd>a list of zscore indicators that should be computed.
The list needs to have 4 named values:<dl>
 <dt>name</dt>
<dd>The name or abbreviation of the indicator.
 This will appear in the column names of the output.</dd></dl></dd> <dt>column</dt>
<dd>The column name without the 'z' of the zscore that shall be
 used.</dd> <dt>with_cutoffs</dt>
<dd>TRUE iff cutoffs for the indicator shall be computed.</dd> <dt>with_auxiliary_zscore_column</dt>
<dd>TRUE iff z-score should be set to
 -3.1 if <code>oedema = "y"</code> for prevalence estimates.</dd> <dt>auxiliary_zscore_condition</dt>
<dd>optional function to define a special
 condition when the z-score should be set to -3.1</dd>
</dl>
<dt>survey_subsets</dt>
<dd>subsets for which the prevalence values should be
computed. It is a named list of characters, where the values correspond
to columns and the names to labels in the output.</dd>

Arguments

Compute prevalence of zscores — anthro_api_compute_prevalence

<dl>

<dt>data</dt>
<dd>a data frame containing the underlying data</dd>


<dt>zscores_to_compute</dt>
<dd>a list of zscore indicators that should be computed.
The list needs to have 4 named values:<dl>
 <dt>name</dt>
<dd>The name or abbreviation of the indicator.
 This will appear in the column names of the output.</dd>

 <dt>column</dt>
<dd>The column name without the 'z' of the zscore that shall be
 used.</dd>

 <dt>with_cutoffs</dt>
<dd>TRUE iff cutoffs for the indicator shall be computed.</dd>

 <dt>with_auxiliary_zscore_column</dt>
<dd>TRUE iff z-score should be set to
 -3.1 if <code>oedema = "y"</code> for prevalence estimates.</dd>

 <dt>auxiliary_zscore_condition</dt>
<dd>optional function to define a special
 condition when the z-score should be set to -3.1</dd>


</dl></dd>


<dt>survey_subsets</dt>
<dd>subsets for which the prevalence values should be
computed. It is a named list of characters, where the values correspond
to columns and the names to labels in the output.</dd>

</dl>

anthro_api_compute_prevalence: Compute prevalence of zscores

Description

Usage

Arguments