Man pages for pepfar-datim/datapackr
A Package that Packs and Unpacks all Data Packs

addValidationsSiteAdd validations tab and options to Site tool
api_callStart DATIM API query and specify table
api_fieldsSelect fields to return from a DATIM API query.
api_filterFilter a DATIM API query.
api_getExecute and return a DATIM API query.
api_versionReturns version of the API
can_read_fileTest for file read access
checkColStructurecheckColStructure(d)
checkOUinfocheckOUinfo(d)
checkSiteToolColStructurecheckSiteToolColStructure(d)
checkSiteToolStructurecheckSiteToolStructure(d)
checkWorkbookStructurecheckWorkbookStructure(d)
colorCodeSitesColor code sites by type
comparePacksCompare Data Pack and Site Tool data
configFileMapping of necessary Data Pack metadata
cop_yearReturns current COP Year
dataPackMapMapping of necessary Data Pack metadata
datapackrData Pack on R datapackr: a grammar of Data Pack manipulation...
data_pack_schemaSchema describing correct structure of Data Pack template.
default_catOptComboReturns 'default' categoryOptionCombo uid.
defunctDisaggsdefunctDisaggs(d)
deriveTargetsDerive non-Data Pack targets from others in the Data...
DHISLoginDHISLogin(config_path)
emptySiteToolSheetFrameemptySiteToolSheetFrame(d)
exportPackrExport output.
FASTforwardFASTforward(d)
frameDataSheetwriteDataSheet(wb, type = "Data Pack")
frameMechMapFrame a mechanism mapping tool.
getCountriesPull list of Countries from DATIM.
GetCredentialsFromConsoleGetCredentialsFromConsole()
getIMPATTLevelsPull IMPATT levels from DATIM for all PEPFAR countries
getMechListCompile Mechanism List for Site Tool
getMilitaryNodesPull all _Military nodes from DATIM for all PEPFAR countries
getPSNUsPull list of PSNUs from DATIM and format based on datapackr...
getSiteListCompile Site List for Site Tool
handshake_fileTest an input file for read access and type. Prompt if...
indicatorMapMap of Data Pack dataelements and categoryoptioncombos.
interactive_printPrints message if session is interactive.
LoadConfigFileLoadConfig(config_path)
loginToDATIMLog into DATIM using DATIM credentials
packDataPackPack a Data Pack
packForDATIMpackForDATIM(data)
packFrameCreate a Site Tool from scratch and prep it for data.
packMechMapCreate Mechanism Mapping tool
packSiteToolPack a Site Tool
packSUBNAT_IMPATTpackSUBNAT_IMPATT(d)
periodInfoperiodInfo
prioritizationsMapping of DATIM Prioritization numerals to strings.
PSNUxIM_to_DATIMMap of indicators from PSNU x IM dataset to DATIM
rePackPSNUxIMrePackSNUxIM(d)
round_truncRound at 0.5 toward integer with highest absolute value
selectOUUse the console to select OU
separateDataSetsseparateDataSets(d)
SiteToDATIMSiteToDATIM
site_tool_schemaSchema describing correct structure of Site Tool template.
styleGuideLibrary of Openxlsx style objects to apply to both Data Pack...
swapColumnsSwap columns between dataframes
template_schemaSchema describing correct structure of Data Pack template.
unPackDataUnpack a submitted Data Pack
unPackMechanismMapUnpack Mechanism Maps for use in site distributions.
unPackSchemaExtract and save schema from Data Pack template.
unPackSheetunPackSheet(d)
unPackSheetsunPackSheets(d)
unPackSiteToolDataunPackSiteToolData(submission_path,output_path,archive_results)
unPackSiteToolSheetunPackSiteToolSheet(d)
unPackSiteToolSheetsunPackSiteToolSheets(d)
unPackSNUxIMunPackSNUxIM(d)
ValidateConfigCheck login credentials
valid_dp_disaggsLists valid disaggs for each Data Pack and Site Tool tab.
writeComparisonWorkbookWrite a comparison workbook
writeFxColumnwiseWrite character vector of Excel formulas into Openxlsx...
writeHomeTabwriteHomeTab(wb, datapack_uid, type = "Data Pack")
write_site_level_sheetWrite Site Tool sheet
pepfar-datim/datapackr documentation built on Aug. 16, 2019, 12:34 p.m.