R/stu_qtr_enrollment.R

In Edgar-Zamora/bbccIR: Instutional Research package

#' Check student enrollment in a quarter
#'
#' @description Running this function will allow one to find the last quarter in which a student is registered in.
#'
#' @param current_qtr This is the last quarter in which a student attended.
#' @param summer_qtr Providing a field will allow for the inclusion of a summer quarter.
#'
#' @importFrom DBI dbConnect
#' @importFrom odbc odbc
#' @importFrom janitor clean_names
#' @import dplyr
#'
#' @return A tibble displaying which students returned in the designated quarters.
#' @export
#'
#' @examples
#' \dontrun{
#'
#' stu_not_registered_nxt_qtr("B902", summer = TRUE)
#'
#' }
#'

stu_not_registered_nxt_qtr <- function(current_qtr, summer_qtr = FALSE) {

  # Making database connection
  con <- dbConnect(odbc::odbc(), "R Data")

  output <- tbl(con, "dbo_Student") %>%
    filter(StudentIntentID %in% c("A", "B", "F", "G", "M")) %>%
    select(SID, FirstName, LastName, DaytimePhone, EveningPhone, Email, YRQLastAttended, StudentIntentID,
           EducationalProgramID, YRQTargetGrad, CollLevCREarned) %>%
    dplyr::collect() %>%
    janitor::clean_names() %>%
    filter(is.na(yrq_target_grad)) %>%
    inner_join(tbl(con, "dbo_Enrollment") %>%
                 filter(EnrolledCredits > 0) %>%
                 select(SID, YearQuarterID) %>%
                 collect() %>%
                 clean_names(), by = c('sid', 'yrq_last_attended' = 'year_quarter_id')) %>%
    distinct_all() %>%
    left_join(tbl(con, "PROG CIP and NAME") %>%
                collect() %>%
                clean_names() %>%
                select(program_code, program_title_general), by = c('educational_program_id' = 'program_code'))  %>%
    left_join(tbl(con, "YRQ LU") %>%
                collect() %>%
                clean_names() %>%
                select(yrq, year_qtr), by = c("yrq_last_attended" = "yrq")) %>%
    distinct_all() %>%
    arrange(sid)


  # Inclusion of summer quarter
  if(summer_qtr == TRUE){
    output %>%
      filter(yrq_last_attended == {{current_qtr}})
  } else {
    output %>%
      filter(yrq_last_attended == {{current_qtr}} | yrq_last_attended == {{summer_qtr}})
  }
}