datim_validation_params: Standardized package function parameter definitions

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

Standardized package function parameter definitions

Description

Standardized package function parameter definitions

Usage

datim_validation_params(
  csv_header,
  d,
  data,
  dataElementIdScheme,
  datasets,
  filename,
  hasHeader,
  idScheme,
  invalidData,
  iso,
  ISO,
  isoPeriod,
  cocs_in,
  des_in,
  mechs_in,
  ous_in,
  mode_in,
  mode_out,
  organisationUnit,
  orgUnitIdScheme,
  return_violations,
  return_violations_only,
  sig,
  vr,
  wd,
  d2session,
  d2_session
)

Arguments

csv_header	By default, CSV files are assumed to have a header, otherwise FALSE will allow for files without a CSV header.
d	D2 Parsed data frame
data	D2 compliant data frame object
dataElementIdScheme	Should be one of either code, name, shortName, or id. If this paramater is "id", then the Data elements are assumed to be already specififed as UIDs.
datasets	Should be a character vector of data set UIDs. Alternatively, if left missing, user will be promted to choose from a list.
filename	Location of the payload to be imported. Should be a valid import file.
hasHeader	TRUE by default. Should be set to FALSE if the file does not contain header information.
idScheme	Remapping scheme for category option combos.
invalidData	Exclude any (NA or missing) data from the parsed file?
iso	String which identifies the period, such as 2016Q1 or 2016Q2
ISO	Formatted string such as 2016Q1. Refer to DHIS2 documentation for details.
isoPeriod	period to be used for date shift boundaries. If not provided, no boundaries are set.
cocs_in	A vector of category option combinations.
des_in	A vector of data element identifiers (codes, names, or shortNames).
mechs_in	A vector of data element identifiers (codes, names, or shortNames).
ous_in	A vector of organisation unit identifiers (codes, names, or shortNames).
mode_in	Should be one of code, name,shortName or id. This is the class we are mapping from.
mode_out	Should be one of code,name,shortName or id. This is the class we are mapping to.
organisationUnit	Organisation unit ancestor.
orgUnitIdScheme	Should be one of either code, name, shortName or id. If this paramater is "id", then the organisation units are assumed to be already specififed as UIDs
return_violations	Boolean to return violations only.
return_violations_only	Parameter to return only violations or all validation rule evaluations.
sig	MD5 hash of the objects URL reference
vr	Validation rule object
wd	By default, the .R_Cache directory in the working directory.
d2session	DHIS2 Session id
d2_session	DHIS2 Session id

Value

list of all paramaters of this constructor function

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