batch_all_production_tech_support_excel: Batch Job To Create NSSP BioSense Platform Data Quality...

In KSSyndromic/KSSPReport: A Data Quality Report Generator for NSSP BioSense Platform. It automatically sends data quality report emails to all the facilities.

Description

This function uses excel generated information but can be override by additional inputs This function iteratively performs 'write_facilty_report' function for all Kansas Facilities in production targeted toward tech supports. It will generate summary report for all specified facility. The summary workbook shows percents and counts of nulls and invalids, Additionally it generates a timeliness report and creates a table.

Usage

batch_all_production_tech_support_excel(
  facility_spreadsheet,
  input,
  table = NA,
  mft = NA,
  username = NA,
  password = NA,
  start = NA,
  end = NA,
  field = NA,
  optional = T,
  exclude = NA,
  directory = NA,
  email = NA,
  sender = NA,
  email_password = NA,
  personname = NA,
  title = NA,
  phone = NA,
  message = NA
)

Arguments

facility_spreadsheet	location of the facility spreadsheet xlsx
input	location of input.xlsx file.
table	The table that you want to retrieve the data from, as a string.
mft	The MFT (master facilities table) from where the facility name will be retrieved, as a string.
username	Your BioSense username, as a string. This is the same username you may use to log into RStudio or Adminer.
password	Your BioSense password, as a string. This is the same password you may use to log into RStudio or Adminer.
start	The start date time that you wish to begin pulling data from, as a string.
end	The end data time that you wish to stop pulling data from, as a string.
field	Default NA. Can add a string with delimiter of ':'. Only fields that countain those words will be included in the final report.
optional	Default True. If False then remove all optional fields
exclude	Default NA. Can add a string with delimiter of ':'. Exclude fields with certain keywords in the final report.
directory	The directory where you would like to write the reports to (i.e., "~/Documents/MyReports"), as a string.
email	Default False. If True, then the function will atempt to send out a form
sender	Email address of sender. Make sure it's kdhe.KS.gov
email_password	Your Email Password
personname	Your Name to be used in your email text
title	Your job title to be used in your email text
phone	Your phone number to be used in your email text
message	The email message to be sent. Allows for composition of costume messages.

Value

First the program will ask if the facility spread sheet is up to date. If answer is yes, generate report table stored at directory location. If email=TRUE, then a email will be sent. A table with facility, receiver and conformation of email being sent. In addition, there will be a TechReport.csv file listing whether the email got sent.

Examples

library(biosensequality)
batch_all_production_tech_support_excel(facility_spreadsheet="Facilities Spreadsheet_New.xlsx",input="Input.xlsx")
##you can override fields from the input.xlsx
batch_all_production_tech_support_excel(facility_spreadsheet="Facilities Spreadsheet_New.xlsx",input="Input.xlsx",email=F)

KSSyndromic/KSSPReport documentation built on Sept. 25, 2021, 1:03 p.m.