unPackTool: Unpack a submitted tool

View source: R/unPackTool.R

unPackToolR Documentation

Unpack a submitted tool

Description

Processes a submitted Data Pack by identifying integrity issues, checking data against DATIM validations, and extracting data.

Usage

unPackTool(
  submission_path = NULL,
  tool = NULL,
  country_uids = NULL,
  season = NULL,
  cop_year = NULL,
  pzns = NULL,
  mer_data = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE)
)

Arguments

submission_path

Local path to the file to import.

tool

Type of tool this function will create or interact with. Either OPU Data Pack or Data Pack

country_uids

Unique IDs for countries to include in the Data Pack. For full list of these IDs, see datapackr::valid_OrgUnits.

season

Either COP or OPU.

cop_year

COP Year to use for tailoring functions. Remember, FY22 targets = COP21.

d2_session

DHIS2 Session id. R6 datimutils object which handles authentication with DATIM.

Details

Executes the following operations in relation to a submitted tool

  1. Performs integrity checks on file structure;


pepfar-datim/datapackr documentation built on April 14, 2024, 10:35 p.m.