Package 'Wavelength'

Description

Apply Time Stamp to file and

Usage

apply_filetimestamp(df, gdrive_rename = TRUE)

Arguments

Description

Additional/optional validation against DATIM tables.

Usage

check_content(df, output_path, datim_path)

Arguments

Value

df updated HFR dataframe

See Also

Other validation: check_dates(), check_disaggs(), check_orgunituids(), check_output_cols(), is_hfrtab(), validate_import(), validate_initial(), validate_output()

Description

Check whether there are any rows/records with missing dates. Provides readout on this as well as on whether the submission covers multiple periods and the dates covered in the file.

Usage

check_dates(df)

Arguments

See Also

Other validation: check_content(), check_disaggs(), check_orgunituids(), check_output_cols(), is_hfrtab(), validate_import(), validate_initial(), validate_output()

Description

Check whether there are any rows/records with missing disaggs and provides readout

Usage

check_disaggs(df)

Arguments

See Also

Other validation: check_content(), check_dates(), check_orgunituids(), check_output_cols(), is_hfrtab(), validate_import(), validate_initial(), validate_output()

Description

Check OUs listed in operatingunit

Usage

check_distinct_ous(df)

Arguments

See Also

Other internal: check_template_cols(), count_missing(), flag_extra(), flag_missing(), hfr_export_mech()

Description

Check whether there are any rows/records with missing indicators and provides readout

Usage

check_inds(df)

Arguments

Description

Check whether there are any rows/records with missing mechanisms and provides readout of the mechanisms included

Usage

check_mechs(df)

Arguments

Description

Check whether there are any rows/records with missing orgunits and provides readout

Usage

check_orgunituids(df)

Arguments

See Also

Other validation: check_content(), check_dates(), check_disaggs(), check_output_cols(), is_hfrtab(), validate_import(), validate_initial(), validate_output()

Description

Ensure all expected columns exist before exporting

Usage

check_output_cols(df)

Arguments

See Also

Other validation: check_content(), check_dates(), check_disaggs(), check_orgunituids(), is_hfrtab(), validate_import(), validate_initial(), validate_output()

Description

Checks template's columns

Usage

check_template_cols(df)

Arguments

See Also

Other internal: check_distinct_ous(), count_missing(), flag_extra(), flag_missing(), hfr_export_mech()

Description

Confirm validations of processed files

Usage

confirm_validations(hfr_data, hfr_errors, dir_files)

Arguments

Examples

## Not run: 
confirm_validations(hfr_data, hfr_errors, dir_files)

## End(Not run)

Description

Counts the number of rows where there are missing records

Usage

count_missing(df, var)

Arguments

See Also

Other internal: check_distinct_ous(), check_template_cols(), flag_extra(), flag_missing(), hfr_export_mech()

Description

Current Fiscal Year

Usage

curr_fy

Format

An object of class numeric of length 1.

Value

Current Fiscal Year

Description

This code should be run on HFR submission prior to loading into DDC/s3. Currently, DDC cannot handle two issues - (1) tabs with only one row of data and (2) tabs not ordered from least to greatest This code resolves the first by creating a second row of data with the first value and the second by reordering tabs using openxlsx.

Usage

ddcpv_check(filepath)

Arguments

Value

print out of checks and

Examples

## Not run: 
files <- list.files("ou_submissions/", "xlsx", full.names = TRUE)
ddcpv_check(files[1])
purrr::walk(files, ddcpv_check) 
## End(Not run)

Description

Download New Submission to upload

Usage

download_new(df)

Arguments

Description

Extract OU ISO3 code

Usage

extract_iso3code(pfile)

Arguments

Value

ISO3 3 character iso code

Examples

## Not run: 
  extract_iso3code('HFR_2020.99_XAR_100000_processed_20200528.csv')

## End(Not run)

Description

Extract mechanism code

Usage

extract_mechcode(pfile)

Arguments

Value

mech_code mechanism code

Examples

## Not run: 
  extract_mechcode('HFR_2020.99_XAR_100000_processed_20200528.csv')

## End(Not run)

Description

Flag Extra Variables

Usage

flag_extra(required, submitted)

Arguments

See Also

Other internal: check_distinct_ous(), check_template_cols(), count_missing(), flag_missing(), hfr_export_mech()

Description

Flag Missing Variables

Usage

flag_missing(required, submitted)

Arguments

See Also

Other internal: check_distinct_ous(), check_template_cols(), count_missing(), flag_extra(), hfr_export_mech()

Description

Generate a API URL

Usage

gen_url(
  ou_uid,
  org_lvl,
  org_type = "facility",
  value_type = "results",
  is_hts = FALSE,
  fy_pd = NULL,
  baseurl = "https://final.datim.org/"
)

Arguments

Examples

## Not run: 
 #get OU UID
  ouuid <- identify_ouuids() %>% dplyr::filter(ou == "Ghana")
 #get facility level
  faclvl <- identify_levels("Ghana", "facility", username = myuser, password = mypwd())
 #gen url
  myurl <- gen_url(ouuid, faclvl, org_type = facility) 
## End(Not run)

Description

DATIM API Call for Targets

Usage

get_datim_data(url, username, password)

Arguments

Examples

## Not run: 
 myurl <- paste0(baseurl, "api/29/analytics.json?
                 dimension=LxhLO68FcXm:udCop657yzi&
                 dimension=ou:LEVEL-4;HfVjCurKxh2&
                 filter=pe:2018Oct&
                 displayProperty=SHORTNAME&outputIdScheme=CODE")
 myuser <- "UserX"
 df_datim <- get_datim_data(myurl, myuser, mypwd(myuser)) 
## End(Not run)

Description

DATIM API Call for Targets

Usage

get_datim_targets(url, username, password)

Arguments

Examples

## Not run: 
 myurl <- paste0(baseurl, "api/29/analytics.json?
                 dimension=LxhLO68FcXm:udCop657yzi&
                 dimension=ou:LEVEL-4;HfVjCurKxh2&
                 filter=pe:2018Oct&
                 displayProperty=SHORTNAME&outputIdScheme=CODE")
 myuser <- "UserX"
 df_targets <- get_datim_targets(myurl, myuser, mypwd(myuser)) 
## End(Not run)

Description

Get operating unit name

Usage

get_operatingunit(iso_code, orglevels)

Arguments

Value

operating unit

Examples

## Not run: 
  get_operatingunit(org_levels, 'XWA')

## End(Not run)

Description

Get operating unit name

Usage

guess_operatingunit(pfile, levels, ims)

Arguments

Value

operating unit name

Examples

## Not run: 
  get_mech_ou(ims, 'HFR_2020.99_XAR_100000_processed_20200528.csv')

## End(Not run)

Description

Aggregate data frame to combine rows where needed (minimize row count). Multiple lines may be entered for the same unique reporting combination/id

Usage

hfr_aggr(df)

Arguments

Description

#' Append HFR and DATIM Data

Usage

hfr_append_sources(
  folderpath_hfr,
  folderpath_datim,
  start_date,
  weeks = 4,
  max_date = TRUE,
  folderpath_output
)

Arguments

Description

Creates new columns for specifying the HFR reporting period - fy (20XX) and hfr_pd (fiscal month), 1-12

Usage

hfr_assign_pds(df)

Arguments

Examples

## Not run: 
 df <- hfr_assign_pds(df) 
## End(Not run)

Description

Function to export different data frames with standardized naming formats

Usage

hfr_export(
  df,
  folderpath_output = NULL,
  type = "processed",
  by_mech = FALSE,
  quarters_complete = NULL
)

Arguments

Examples

## Not run: 
 #write output
   hfr_export(df_tza, "~/WeeklyData") 
## End(Not run)

Description

Export csv files by mechanism

Usage

hfr_export_mech(df, mech, type, folderpath_output, quarters_complete)

Arguments

See Also

Other internal: check_distinct_ous(), check_template_cols(), count_missing(), flag_extra(), flag_missing()

Description

Useful for pulling information about the template, whether It be the Operating Unit (OU), Period, template version, or type, eg wide or long.

Usage

hfr_extract_meta(filepath, meta_type = "type")

Arguments

Examples

## Not run: 
#identify whether template is long or wide
  filepath <- "~/WeeklyData/Raw/KEN_Weekly.xlsx"
  hfr_extract_meta(filepath, meta_type = "type")
#identify period
  hfr_extract_meta(filepath, meta_type = "period")
#identify OU
  hfr_extract_meta(filepath, meta_type = "ou") 
## End(Not run)

Description

Limits data frame to only the current reporting period when the fiscal year and period are provided.

Usage

hfr_filter_pd(df, hfr_pd_sel = NULL, hfr_fy_sel = NULL)

Arguments

Description

The submission templates do not have date validations stored in the Excel files, so there can be a number of date types submitted that we attempt to account for outside of the normal, ISO format of YYYY-MM-DD. This function handles each identfied date type as a separate dataframe and then binds them back together. Date formats include - Excel, ISO, character dates. If the round_hfrdate param is TRUE, the function rounds to the start of the week or month and aggregates any mid-week/month submission.

Usage

hfr_fix_date(df, round_hfrdate = FALSE)

Arguments

Description

A number of issues crop up frequently enough around indicators, disaggregates, values, etc, that worth coding a resolution into a singular place. This function aims to be a place to rectify any non-standard issue that arises more than a couple of times.

Usage

hfr_fix_noncompliance(df)

Arguments

Description

Generate Gap Targets

Usage

hfr_gap_target(df, quarters_complete)

Arguments

Examples

## Not run: 
 myuser <- "UserX"
 mech_x_targets <- extract_datim(00001, myuser, mypwd(myuser))
 mech_x_targets <- hfr_gap_target(mech_x_targets, 2) 
## End(Not run)

Description

Tidy Wide or Wide-LIMITED submissions by pivoting them long and separating column name into relevant parts.

Usage

hfr_gather(df)

Arguments

Description

Changes frequency from week to month agg and rounds up to month

Usage

hfr_group_wkly(df)

Arguments

Description

DDC Status Report Google Sheet ID

Usage

hfr_gs_statrep

Format

An object of class character of length 1.

Value

google sheet id

Description

Flags the frequency of reporting, adding this to the data frame for tracking and for use if rounding and aggregating.

Usage

hfr_identify_freq(df)

Arguments

Description

Create a data frame of HFR weeks and periods

Usage

hfr_identify_pds(fy = NULL, week = FALSE)

Arguments

Description

Read in a standard HFR submission, binding all tabs into one. Note that all tabs must be in the same template format - all long, wide, or wide-limited.

Usage

hfr_import(filepath)

Arguments

Examples

## Not run: 
#identify whether template is long or wide
  filepath <- "~/HFR/HFR_FY23_Oct_Moldova_20221015.xlsx"
  df_hfr <- hfr_import(filepath) 
## End(Not run)

Description

Clean up/standardize string text for indicators and disaggregates

Usage

hfr_munge_string(df)

Arguments

Description

A look up for an partial orgunit name against the DATIM list of orgunits, when trying to find the correct or missing orgunituid

Usage

hfr_orgunit_search(df, orgunit_name, ou = NULL)

Arguments

Examples

## Not run: 
load_secrets("datim")
org <- pull_hierarchy(datim_user(), datim_pwd())
# orgunit - "Kewot"
hfr_orgunit_search(org, "Kew", "Ethiopia") 
## End(Not run)

Description

Run validation check on country HFR submission while it processes and tidies the submission for inclusion into the database.

Usage

hfr_process_template(
  filepath,
  round_hfrdate = FALSE,
  hfr_pd_sel = NULL,
  folderpath_output = NULL,
  datim_path = NULL
)

Arguments

Examples

## Not run: 
#file path for the
  path <- "~/WeeklyData/Saturn"
  output_folder <- "~/WeeklyData/Output"
#process Excel file for Saturn
  hfr_process_template(path, output_folder)
#process Excel file for Saturn with full validation
  datim_folder <- "~/Datim"
  hfr_process_template(path, output_folder, datim_path = datim_folder)

## End(Not run)

Description

Read in HFR output file

Usage

hfr_read(filepath)

Arguments

Examples

## Not run: 
 path <- "~/data/HFR_2020.01_Global_output_20191204.1705.csv"
 df <- hfr_read(path)
 
## End(Not run)

Description

Batch read hfr files

Usage

hfr_read_all(pfolder, pattern, source = FALSE)

Arguments

Value

df

Examples

## Not run: 
  hfr_read_all('./Data/2020.05', pattern='HFR_FY2020.05')

## End(Not run)

Description

Without access to change data directly in the database, the only means of changing data is to resubmit a zeroed out version of the original submission. This function replaces any cell with entered data with zero so that it can be resubmitted and processed by Trifacta. The original, correct version should be re-processed after the zeroed dataset has been processes

Usage

hfr_rectify_date(subm_file, subm_tab, folderpath_templates = "templates/")

Arguments

Value

exports two files - one with zeroed out data for wrong date and one with corrected date

Examples

## Not run: 
#store file paths for looping over to read in
  df_files_tabs <- list.files(folderpath, full.names = TRUE) %>%
    purrr::map_dfr(~ tibble::tibble(file = .x,
                                    tabs = readxl::excel_sheets(.x))) %>%
    dplyr::filter(stringr::str_detect(tabs, "HFR"))
#fix date and create zeroed version for wrong date (to clean from DB)
 pwalk(df_files_tabs, ~hfr_rectify_date(..1, ..2)) 
## End(Not run)

Description

Limits the datafram to only have the exact columsn found in the template, removing any extras

Usage

hfr_restrict_cols(df)

Arguments

Description

Round values to nearest HFR date

Usage

hfr_round_date(df)

Arguments

Description

Clean up DATIM Hierarchy Path

Usage

hierarchy_clean(df)

Arguments

Description

Pull Hierarchy Data from DATIM

Usage

hierarchy_extract(
  ou_uid,
  username,
  password,
  baseurl = "https://final.datim.org/"
)

Arguments

Examples

## Not run: 
#get OU UID
  ouuid <- identify_ouuids() %>% dplyr::filter(ou == "Kenya")
#pull hierarchy (paths are all UIDs)
  df <- hierarchy_extract(ouuid, username = myuser, password = mypwd(myuser)) 
## End(Not run)

Description

Extract country name from OU or country name

Usage

hierarchy_identify_ctry(df)

Arguments

Description

Rename Hierarchy from Levels to OU/SNU1/PSNU/Facility

Usage

hierarchy_rename(
  df,
  country,
  username,
  password,
  baseurl = "https://final.datim.org/"
)

Arguments

Description

Identify Facility/Community levels in org hierarchy

Usage

identify_levels(
  ou = NULL,
  username,
  password,
  baseurl = "https://final.datim.org/"
)

Arguments

Examples

## Not run: 
 #table for all OUs
  myuser <- "UserX"
  identify_levels(username = myuser, password = mypwd())
 #table for just Kenya
   identify_levels("Kenya", username = myuser, password = mypwd()) 
## End(Not run)

Description

Identify New Submissions on Google Drive

Usage

identify_newfiles(print_files = TRUE, id_modified = TRUE)

Arguments

Value

new files, along with submission (df_submissions) and s3 files from the archive folder (df_archive)

Description

Pull OU UIDS

Usage

identify_ouuids(username, password, baseurl = "https://final.datim.org/")

Arguments

Examples

## Not run: 
 ous <- identify_ouuids("userx", mypwd("userx")) 
## End(Not run)

Description

Validate reporting dates

Usage

is_date_valid(.data, df_dates)

Arguments

Value

boolean

Examples

## Not run: 
  data %>% is_date_valid(df_dates)

## End(Not run)

Description

Determine if there are tabs to import

Usage

is_hfrtab(filepath)

Arguments

See Also

Other validation: check_content(), check_dates(), check_disaggs(), check_orgunituids(), check_output_cols(), validate_import(), validate_initial(), validate_output()

Description

Validate mechanism code

Usage

is_mech_valid(.data, df_mechs)

Arguments

Value

boolean

Examples

## Not run: 
  data %>% is_mech_valid(df_dates)

## End(Not run)

Description

Validate mechanism code

Usage

is_mech4ou(.data, df_mechs)

Arguments

Value

boolean

Examples

## Not run: 
  data %>% is_mech4ou_valid(df_mechs)

## End(Not run)

Description

Determine whether meta tab exists

Usage

is_metatab(filepath)

Arguments

See Also

Other utility: package_check(), var_exists()

Description

Check if Operating Unit name is valid

Usage

is_orgunituid_valid(.data, df_orgs)

Arguments

Value

boolean

Examples

## Not run: 
  data %>% is_orgunituid_valid(df_orgs)

## End(Not run)

Description

Check if orgunituid exist in operating unit

Usage

is_orgunituid4ou(.data, df_orgs)

Arguments

Value

data with new column: T/F

Examples

## Not run: 
  data %>% orgunituid4ou(df_orgs)

## End(Not run)

Description

Check if OperatingUnit is valid

Usage

is_ou_valid(.data, df_orgs)

Arguments

Value

boolean

Examples

## Not run: 
  data %>% is_ou_valid(df_orgs)

## End(Not run)

Description

Table that cross references the ISO Country codes to the PEPFAR Operating Units and Countries. This table is used during the export process for file naming. ISO codes were originall pulled from DATIM.

Usage

data(iso_map)

Format

A data frame with each PEPFAR OU and associated ISO code.

operatingunit

PEPFAR Operating Unit or country

iso

3 letter ISO code for the Operatingunit or country

regional

TRUE if operatingunit is a country under a regional program

Source

"https://final.datim.org/api/dataStore/dataSetAssignments/orgUnitLevels"

Description

Load DATIM Look up tables

Usage

load_lookups(datim_path = "./Data/", local = TRUE, user = NULL)

Arguments

Examples

## Not run: 
 #load look up data
 load_lookups(datim_path = "./Data/datim")
 load_lookups(datim_path = "999#1aw####")
 
## End(Not run)

Description

Identify S3 file names matching Ignored files

Usage

match_ignoredfiles(file_name, df_ref, ref_name = "name")

Arguments

Examples

## Not run: 

  library(tidyverse)
  library(Wavelength)
  library(googlesheets4)

  ss_sbm <- as_sheets_id("<xyz>")

  df_ignore_files <- read_sheet(ss = ss_sbm, "ignore_files")

  df_new <- identify_newfiles() # this will also generate df_submissions & df_archive

  # Ghost files
  df_ghosts <- df_submissions %>%
     full_join(df_archive, by = c("name" = "sys_data_object")) %>%
     filter(is.na(exists_gdrive))

  # Match ignored files
  df_ignore_files <- df_ignore_files %>%
    mutate(names_s3 = match_ignoredfiles(name_googledrive, df_ghosts, "name")

  # Update ignore files table
  range_write(ss = sbm_form,
              data = df_ignore_files,
              sheet = "ignore_files",
              col_names = TRUE)

## End(Not run)

Description

Table of OPM Holidays for 2021-26 for scheduling submission dates.

Usage

data(opm_holiday)

Format

A data frame with each Federaly observed holiday from 2021-2026.

date_holiday_obs

date holiday is observered

holiday

holiday

Source

"https://www.opm.gov/policy-data-oversight/pay-leave/federal-holidays"

Description

Check if package exists

Usage

package_check(pkg)

Arguments

Value

warning message if package is not installed

See Also

Other utility: is_metatab(), var_exists()

Description

Paint console text in blue

Usage

paint_blue(txt)

Arguments

See Also

Other text_color: paint_green(), paint_red(), paint_yellow()

Description

Paint console text in green

Usage

paint_green(txt)

Arguments

See Also

Other text_color: paint_blue(), paint_red(), paint_yellow()

Description

Paint console text in red

Usage

paint_red(txt)

Arguments

See Also

Other text_color: paint_blue(), paint_green(), paint_yellow()

Description

Paint console text in yellow

Usage

paint_yellow(txt)

Arguments

See Also

Other text_color: paint_blue(), paint_green(), paint_red()

Description

Parse out submitted file components

Usage

parse_submission(pfile)

Arguments

Value

component As vector c("hfr_pd", "iso3", "mech_code", "pdate")

Examples

## Not run: 
  parse_submission("HFR_2020.99_XWH_100000_processed_20200101.csv")

## End(Not run)

Description

Compile PEPFAR Hierarchy

Usage

pull_hierarchy(
  ou_uid,
  username,
  password,
  baseurl = "https://final.datim.org/",
  folderpath_output = NULL
)

Arguments

Examples

## Not run: 
#get OU UID
  ouuid <- identify_ouuids() %>% dplyr::filter(ou == "Kenya")
#pull hierarchy (paths are all UIDs)
  df <- pull_hierarchy(ouuid, username = myuser, password = mypwd(myuser)) 
## End(Not run)

Description

Pull Partner/Mechanism Info from DATIM

Usage

pull_mech(usaid_only = TRUE, ou_sel = NULL, folderpath_output = NULL)

Arguments

Examples

## Not run: 
#pull mechanism/partner information
df <- pull_mech() 
## End(Not run)

Description

Extract DATIM Results and Targets (DATIM API Call)

Usage

pull_mer(
  ou_name = NULL,
  username,
  password,
  baseurl = "https://final.datim.org/",
  fy_pd = NULL,
  quarters_complete = NULL,
  folderpath_output = NULL
)

Arguments

Examples

## Not run: 
 #ou mer data
 myuser <- "UserX"
 mech_x_dta <- pull_mer(ou_name = "Namibia", username = myuser, password = mypwd(myuser))
 
## End(Not run)

Description

Report files validation

Usage

report_submissions_errors(df_files, mechanisms, export = FALSE)

Arguments

Value

void

Examples

## Not run: 
  report_file_errors(files, ims, processed)

## End(Not run)

Description

Revert validated file to processed files

Usage

revert_validations(dir_files)

Arguments

Examples

## Not run: 
revert_validations(dir_files)

## End(Not run)

Description

Download from S3 and push to Google Drive

Usage

stash_outgoing(
  prefix = c("HFR_Tableau", "HFR_Submission", "Mechanism", "Detailed"),
  outputfolder,
  gdrive = FALSE
)

Arguments

Examples

## Not run: 
stash_outgoing("HFR_Tableau", "out/joint") 
## End(Not run)

Description

List of column headers for the HFR Long Template

Usage

data(template_cols_long)

Format

A list of all headers

template_cols_long

column names

Description

List of column headers for the HFR Indicator Meta Data

Usage

data(template_cols_meta)

Format

A list of all headers

template_cols_meta

column names

Description

List of column headers for the HFR Wide Template

Usage

data(template_cols_wide)

Format

A list of all headers

template_cols_wide

column names

Description

List of column headers for the HFR Wide Template

Usage

data(template_cols_wide_lim)

Format

A list of all headers

template_cols_wide_lim

column names

Description

Import and munge submitted site list

Usage

tidy_sitelist(filepath, folderpath_output = NULL)

Arguments

Examples

## Not run: 
  path <- "~/Data/HFR_FY21_SiteValidation_Kenya.xlsx"
  df_sites <- tidy_sitelist(path) 
## End(Not run)

Description

Update USAID Mechanism meta table

Usage

update_meta_mechs(savefolder = "out/DATIM", upload = FALSE)

Arguments

Description

Update MER meta table

Usage

update_meta_mer(fy_pd = NULL, savefolder = "out/DATIM", upload = FALSE)

Arguments

Description

Update Organization Hierarchy meta table

Usage

update_meta_orgs(savefolder = "out/DATIM", upload = FALSE)

Arguments

Description

Update MER targets from MSD (prior to site results being available)

Usage

update_meta_targets(fy, savefolder = "out/DATIM", upload = FALSE)

Arguments

Description

Update invalid operating units

Usage

update_operatingunits(hfr_data, levels, orgs, ims = NULL)

Arguments

Value

hfr_data df

Examples

## Not run: 
  update_operatingunits(hfr_df, levels=org_levels, orgs=org_hierarchy, ims=mechanisms)

## End(Not run)

Description

Push meta tables to Google Drive and s3

Usage

upload_meta_table(type = c("mech", "org"), folder = "out/DATIM")

Arguments

Examples

## Not run: 
 #pull updated mechanism table
   pull_mech(folderpath_output = savefolder)
 #upload to Google Drive and s3
   upload_meta_table("mech") 
## End(Not run)

Description

Validate HFR PD Date

Usage

validate_date(df_pds, pdate, pd)

Arguments

Value

valid: True / False

Examples

## Not run: 
  validate_date(df_pds = valid_dates, '2020-01-27', 5)

## End(Not run)

Description

Validate processed hfr data

Usage

validate_hfr_data(hfr_data, orgs, ims, dates, keep_values = FALSE)

Arguments

Value

errors data frame

Examples

## Not run: 
  validate_hfr_data(df_hfr_data, orgs=org_hierarchy, ims=df_mechanisms, dates=df_hfr_dates)
  validate_hfr_data(df_hfr_data, orgs=org_hierarchy, ims=df_mechanisms, dates=df_hfr_dates, keep_values = TRUE)

## End(Not run)

Description

Runs validation on data after reading in the dataset - making sure it has the required column based on the template type and check if there is one ore more operating units.

Usage

validate_import(df)

Arguments

See Also

Other validation: check_content(), check_dates(), check_disaggs(), check_orgunituids(), check_output_cols(), is_hfrtab(), validate_initial(), validate_output()

Description

Performs basic check before importing data - checking if there are any HFR labeled tabs to import and then outputting info from the meta tab (country, filename, and template version) and then about the tabs (what will be imported or excluded)

Usage

validate_initial(filepath)

Arguments

See Also

Other validation: check_content(), check_dates(), check_disaggs(), check_orgunituids(), check_output_cols(), is_hfrtab(), validate_import(), validate_output()

Description

Validate mechanism code

Usage

validate_mechanism(mechanisms, ou, mcode)

Arguments

Value

vector c(valid_im, mech_name)

Examples

## Not run: 
  validate_mechanism(ims, 'Angola', 16172)

## End(Not run)

Description

Validate org unit uid

Usage

validate_orgunit(df_orgs, ou, uid)

Arguments

Value

valid as a vector c(valid_uid, valid_uid_ou)

Examples

## Not run: 
  validate_orgunit(df_orgs, 'Eswatini', 'g48XD8px8NN')

## End(Not run)

Description

Runs a number of validations after the tidying has occured. Additional, optional validations against DATIM data can be run if data are available, from pull_hierarchy,pull_mech, pull_mer

Usage

validate_output(df, output_path, datim_path = NULL)

Arguments

See Also

Other validation: check_content(), check_dates(), check_disaggs(), check_orgunituids(), check_output_cols(), is_hfrtab(), validate_import(), validate_initial()

Description

Validate submitted files

Usage

validate_submission(pfile, levels, ims)

Arguments

Value

vector c("fy", "hfr_pd", "iso3", "operatingunit", "mech_code", "mech_valid", "mech_name", "pdate", "name")

Examples

## Not run: 
  validate_submissions("HFR_2020.99_XWH_100000_processed_20200101.csv")

## End(Not run)

Description

Validate files

Usage

validate_submissions(pfolder, levels, ims, pattern = NULL)

Arguments

Value

dataframe

Examples

## Not run: 
  validate_submissions(dir_hfr_pd205, pattern = "HFR_2020.05")

## End(Not run)

Description

Check if variable exist

Usage

var_exists(df, var)

Arguments

See Also

Other utility: is_metatab(), package_check()

Examples

## Not run: 
var_exists(df, "val") 
## End(Not run)