Screen.purse {COINr} | R Documentation |
Screen units based on data availability
Description
Screens units based on a data availability threshold and presence of zeros. Units can be optionally "forced" to be included or excluded, making exceptions for the data availability threshold.
Usage
## S3 method for class 'purse'
Screen(
x,
dset,
unit_screen,
dat_thresh = NULL,
nonzero_thresh = NULL,
Force = NULL,
write_to = NULL,
...
)
Arguments
x |
A purse object |
dset |
The data set to be checked/screened |
unit_screen |
Specifies whether and how to screen units based on data availability or zero values.
|
dat_thresh |
A data availability threshold ( |
nonzero_thresh |
As |
Force |
A data frame with any additional countries to force inclusion or exclusion. Required columns |
write_to |
If specified, writes the aggregated data to |
... |
arguments passed to or from other methods. |
Details
The two main criteria of interest are NA
values, and zeros. The summary table gives percentages of
NA
values for each unit, across indicators, and percentage zero values (as a percentage of non-NA
values).
Each unit is flagged as having low data or too many zeros based on thresholds.
See also vignette("screening")
.
Value
An updated purse with coins screened and updated.
Examples
# see vignette("screening") for an example.