R/state_invalid.R

In SophiaLC/IHI_DQ: A Data Quality Report Generator for NSSP BioSense Platform

#' Getting Invalid Examples and Summaries for Patient_State
#'
#' This function will generate two data frames: first, a frame to be used later to extract invalid examples from;
#' second, a frame that contains facility-level summaries for counts and percentages of invalid Patient_State.
#' 
#' The valid values were taken from the `PHVS_State_FIPS_5-2_V1.xls` file from 
#' Public Health Information Network Vocabulary Access and Distribution System value sets
#' (https://phinvads.cdc.gov/vads/ViewView.action?name=Syndromic%20Surveillance). The package will
#' be updated as the CDC provides new or different codes that are considered valid or invalid.
#' 
#' You can view the concept codes that are considered valid by calling `data("state")`. This data frame
#' leaves off the zeros in front of single-digit codes; codes with zeros in front of them are explicitly added
#' in the code for the function.
#' 
#' @param data The raw data on which you will do the invalid patient state checks.
#' @return A list of two data frames: examples and summary for the Patient_State.
#' @import dplyr
#' @export
state_invalid <- function(data) {
  
  # generating valid values
  data("state", envir=environment())
  
  valid_state_values <- state %>% # take data
    select(Concept.Code) %>% # the variable we want is called concept code
    filter(!is.na(Concept.Code)) %>% # get rid of any nas
    c() %>% # turn this into a vector
    unlist() %>% # unlist them from the concept name object 
    unname() %>% # remove names
    c("01", "02", "03", "04", "05", "06", "07", "08", "09") # add zeros in front of single digit numbers
  
  # generate examples
  state_examples <- data %>% # take data
    select(c(C_Facility_ID, C_Visit_ID, Patient_State)) %>%  # taking just the variables we need
    mutate(Invalid_Patient_State=case_when(
      is.na(Patient_State) ~ NA, # if na then keep na
      Patient_State %in% valid_state_values ~ FALSE, # if state is found in valid values, false
      !Patient_State %in% valid_state_values ~ TRUE # if it isn't, then true
      ))
  
  # generate summary
  state_summary <- state_examples %>% # take the examples
    group_by(C_Visit_ID) %>% # group by patient visit
    mutate(Any_Invalid_Patient_State=case_when(
      all(is.na(Invalid_Patient_State)) ~ NA, # if all is na, keep na
      sum(Invalid_Patient_State, na.rm=TRUE) == 0 ~ FALSE, # if none are true, then invalid is false
      TRUE ~ TRUE # otherwise, true
    )) %>%
    slice(1) %>% # take one row per patient visit
    ungroup() %>% # explicitly ungroup
    group_by(C_Facility_ID) %>% # group by facility
    summarise(Patient_State.Percent=round(mean(Any_Invalid_Patient_State, na.rm=TRUE)*100,2), # percent
              Patient_State.Count=sum(Any_Invalid_Patient_State, na.rm=TRUE)) # count
  
  return(
    list(state_examples=state_examples,
         state_summary=state_summary)
  )
}