write_facility_excel: Write NSSP BioSense Platform Data Quality Summary Reports for...

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 performs 'write_facilty_report' function for all . It will generate summary report for all specified facility. This function uses excel generated information although one can override the information from the input.xlsx The summary workbook shows percents and counts of nulls and invalids, Additionally it generates a timeliness report and creates a table. The program can send out a report to designated email address

Usage

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

Arguments

input	location of input.xlsx file.
facility	The C_Biosense_Facility_ID for the facility that you wish to generate and write the report for.
receiver	Email address of receiver.
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.
directory	The directory where you would like to write the reports to (i.e., "~/Documents/MyReports"), 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.
exclude	Default NA. Can add a string with delimiter of ':'. Exclude fields with certain keywords in the final report.
optional	Default True. If False then remove all optional fields
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 @param message The email message to be sent. Allows for composition of costume messages.

Examples

library(biosensequality)
write_facility_excel("Input.xlsx")
## You can override options from input by filling in the parameters you need to override
write_facility_excel("Input.xlsx", email=F)

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