processData: Process RHoMIS data
In l-gorman/rhomis-R-package: Essential Processes for RHoMIS Data

processData

R Documentation

Process RHoMIS data

Description

A main function that can be used to process rhomis data. Whether the dataset comes from a local csv or from ODK central.

Usage

processData(
  extractUnitsOnly = T,
  calculateInitialIndicatorsOnly = F,
  calculateFinalIndicatorsOnly = F,
  dataSource = c("csv", "central"),
  outputType = c("csv", "mongodb"),
  base_path = "./",
  dataFilePath = NULL,
  id_type = c("string", "column"),
  proj_id,
  form_id,
  uuid_local = pkg.env$identification_column_list$uuid_local,
  central_url = NULL,
  central_email = NULL,
  central_password = NULL,
  project_name = NULL,
  form_name = NULL,
  database = NULL,
  isDraft = NULL,
  central_test_case = FALSE,
  gender_categories = pkg.env$gender_categories
)

Arguments

`extractUnitsOnly`	Whether or not to only extract units (TRUE/FALSE)
`calculateInitialIndicatorsOnly`	Whether or not to only calculate initial indicators (TRUE/FALSE)
`calculateFinalIndicatorsOnly`	Whether or not to only calculate final indicators
`dataSource`	The type of RHoMIS data being fed into the calculations, whether a local csv file or data from ODK central. Options "csv" or "central".
`outputType`	The type of output to produce (options are "csv" or "mongodb")
`base_path`	The path where all of the data processing should take place
`dataFilePath`	The file to the data (csv format). ONLY RELEVANT IF "dataSource" WAS "local".
`id_type`	The type of ID you would like to use ("string" or "column")
`proj_id`	An ID for your project
`form_id`	An ID for your form
`uuid_local`	The column in a local dataset containing uuids (usually _uuid)
`central_url`	The url of the ODK-central server you are using. ONLY RELEVANT IF "dataSource" WAS "central".
`central_email`	The email of the ODK-central account you are using. ONLY RELEVANT IF "dataSource" WAS "central"
`central_password`	The password of the ODK-central account you are using. ONLY RELEVANT IF "dataSource" WAS "central".
`project_name`	The name of the ODK-central project you are processing. ONLY RELEVANT IF "dataSource" WAS "central".
`form_name`	The name of the ODK-central form you are processing. ONLY RELEVANT IF "dataSource" WAS "central".
`database`	The name of the database you would like to save results to
`isDraft`	Whether or not the ODK form you are working with is a draft or a final version. Only relevant if you are processing a project from ODK central
`central_test_case`	This flag is used for running a test-sample dataset from ODK the inst/sample_central_project/ folder
`gender_categories`	The gender categories present in the data which is to be processed

Details

RHoMIS datasets go through 4 stages of processing:

1. Initial Cleaning and Extracting Units 2. Calculation of initial indicators 3. Calculation of final indicators, including food availability, gender, and value of products consumed

Rpackage file: RunAll.R

l-gorman/rhomis-R-package documentation built on Nov. 8, 2023, 6:46 a.m.