Treat.purse

This function calls <code>Treat.coin()</code> for each coin in the purse. See the documentation of that function for
details. See also <code>vignette("treat")</code>.

A comprehensive high-level package, for composite indicator construction and analysis. It is a "development environment"
for composite indicators and scoreboards, which includes utilities for construction (indicator selection, denomination, imputation,
data treatment, normalisation, weighting and aggregation) and analysis (multivariate analysis, correlation plotting, short cuts for
principal component analysis, global sensitivity analysis, and more). A composite indicator is completely encapsulated inside a single
hierarchical list called a "coin". This allows a fast and efficient work flow, as well as making quick copies, testing methodological variations and making comparisons.
It also includes many plotting options, both statistical (scatter plots, distribution plots) as well as for presenting results.

William Becker

COINr

Composite Indicator Construction and Analysis

Treat.purse function

<dl><dt>x</dt>
<dd>A purse object</dd>
<dt>dset</dt>
<dd>The data set to treat in each coin.</dd>
<dt>global_specs</dt>
<dd>Default specifications. See details in <code>Treat.coin()</code>.</dd>
<dt>indiv_specs</dt>
<dd>Individual specifications. See details in <code>Treat.coin()</code>.</dd>
<dt>combine_treat</dt>
<dd>By default, if <code>f1</code> fails to pass <code>f_pass</code>, then <code>f2</code> is applied to the original <code>x</code>,
rather than the treated output of <code>f1</code>. If <code>combine_treat = TRUE</code>, <code>f2</code> will instead be applied to the output
of <code>f1</code>, so the two treatments will be combined.</dd>
<dt>write_to</dt>
<dd>If specified, writes the aggregated data to <code>.$Data[[write_to]]</code>. Default <code>write_to = "Treated"</code>.</dd>
<dt>disable</dt>
<dd>Logical: if <code>TRUE</code> will disable data treatment completely and write the unaltered data set. This option is mainly useful
in sensitivity and uncertainty analysis (to test the effect of turning imputation on/off).</dd>
<dt>...</dt>
<dd>arguments passed to or from other methods.</dd></dl>

Arguments

Treat a purse of coins for outliers — Treat.purse

<dl>

<dt>x</dt>
<dd>A purse object</dd>


<dt>dset</dt>
<dd>The data set to treat in each coin.</dd>


<dt>global_specs</dt>
<dd>Default specifications. See details in <code>Treat.coin()</code>.</dd>


<dt>indiv_specs</dt>
<dd>Individual specifications. See details in <code>Treat.coin()</code>.</dd>


<dt>combine_treat</dt>
<dd>By default, if <code>f1</code> fails to pass <code>f_pass</code>, then <code>f2</code> is applied to the original <code>x</code>,
rather than the treated output of <code>f1</code>. If <code>combine_treat = TRUE</code>, <code>f2</code> will instead be applied to the output
of <code>f1</code>, so the two treatments will be combined.</dd>


<dt>write_to</dt>
<dd>If specified, writes the aggregated data to <code>.$Data[[write_to]]</code>. Default <code>write_to = "Treated"</code>.</dd>


<dt>disable</dt>
<dd>Logical: if <code>TRUE</code> will disable data treatment completely and write the unaltered data set. This option is mainly useful
in sensitivity and uncertainty analysis (to test the effect of turning imputation on/off).</dd>


<dt>...</dt>
<dd>arguments passed to or from other methods.</dd>

</dl>

Treat.purse: Treat a purse of coins for outliers

Description

Usage

Value

Arguments

Examples