validateData: Function which checks the of a DATIM data payload against...

In jason-p-pickering/datim-validation: External Validation Routines for Data Payloads in DATIM

Function which checks the of a DATIM data payload against define validation rules

Description

validateData should be supplied a d2Parser compliant data frame. The data frame is checked dynamically against validation rules defined in the DATIM server.

Usage

validateData(
  data,
  organisationUnit = NA,
  return_violations_only = TRUE,
  parallel = FALSE,
  vr = NULL,
  d2session = dynGet("d2_default_session", inherits = TRUE)
)

Arguments

data	D2 compliant data frame object
organisationUnit	Organisation unit ancestor.
return_violations_only	Parameter to return only violations or all validation rule evaluations.
parallel	Should the rules be evaluated in parallel. Default is to not evaluate in parallel.
vr	Validation rule object
d2session	DHIS2 Session id

Value

Returns a data frame with validation rule results.

Examples

## Not run: 
  d <- d2Parser("myfile.csv",type="csv")
  vr_rules <- validateData(d)
  doMC::registerDoMC(cores=4)
  vr_rules <- validateData(d,parallel=TRUE)
  ds <- getCurrentDataSets(type="RESULTS")
  vr_rules <- validateData(d,parallel=TRUE,datasets=ds)

## End(Not run)

jason-p-pickering/datim-validation documentation built on April 20, 2023, 5:32 a.m.