varTests-HDSS: Check raw HDSS data
In alexploner/R.HDSS: Process HDSS demographic data from the INDEPTH project

Description Usage Arguments Details Value References See Also

These functions test whether a given dataframe read by readRawHDSS is a valid HDSS data set in terms of variables present and a valid unique identifier.

1
2
3

coreVariableTests(x)

vaVariableTests(x)

`x`	The data frame to be validated

These functions provide a pragmatic way of testing core requirements for valid HDSS data. While is not a full validation of a formal HDSS specification, it is a set of reasonable tests: a data set that fails them will likely need manual intervention before further processing; a data set that passes them can be pre-processed before checking the actual content of the variables (see e.g. coreRecTests).

coreVariableTests checks for the presence of the basic variables specified in Sankoh & Byass (2012), the presence of a valid unique record identifier, and for some crucial variables also the presence of missing values.

vaVariableTests checks for the presence of verbal autopsy variables (given as Cause1 to Cause3 and Likelihood1 to Likelihood3. This is not part of the core HDSS specification, and may or may not be present in a data set.

Each test returns a list with two entries:

flag a logical flag hat indicates whether all tests were passsed or not
text a data frame with one column that contains the error messages from the failed tests; empty if all tests were passed

Osman Sankoh and Peter Byass. The INDEPTH Network: filling vital gaps in global epidemiology. Int J Epi 2012; 41:579-588, Tables 1 and 2.

var-check-tools readRawHDSS preprocHDSS coreRecTests

alexploner/R.HDSS documentation built on May 12, 2019, 2:32 a.m.