From 5e0c535cb2e8cef1c74873e674eaacff02dfd666 Mon Sep 17 00:00:00 2001 From: Nicolas Date: Mon, 25 Jul 2016 12:17:08 +0200 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ff4594..cadae38 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# xva \ No newline at end of file +# xva + +**Description** + +R-Converter for converting verbal autopsy records collected using the WHO VA 2014 instrument to be used as input for different coding algorithms. + +**Input** +- CSV file containing submissions of the 2014 WHO VA questionnaire (exported from ODK Aggregate) +- One or more mapping files (text file, semi-colon as column separator). Minimal content: the first columns contains the names of all variables needed by the coding algorithm (called "target variables" here). The second column contains the mapping to each target variable, as a valid R expression. Expressions can be functions of zero or more variables of the WHO VA instrument, or any of the preceding target variable. In addition to standard R functions, a small set of convenience functions is provided in xda.R. + +**Output** +A CSV file intended for processing by a coding algorithm. + + +**Status** + +Initial, not intended for production use + +**Testing** + +For testing purposes, install via +``` +install.packages("devtools") +devtools::install_github("SwissTPH/xva") +```