R/linking.R

Defines functions ny_linking

Documented in ny_linking

#' ny linking
#'
#' @param measurementscale MAP subject
#' @param current_grade grade level
#' @param season c('Fall', 'Winter', 'Spring')
#' @param RIT rit score
#' @param returns one of c('perf_level', 'proficient')
#'
#' @return either character, length 1 with performance level or logical, 
#' length 1, with proficiency
#' @export

ny_linking <- function(measurementscale, current_grade, season, RIT, returns = 'perf_level') {
 
  valid_returns <- c('perf_level', 'proficient')
  returns %>% ensurer::ensure_that(
    . %in% valid_returns ~ 
      paste0("returns should be one of: ", 
        paste(valid_returns, collapse = ', ')
      )
  )
  
  out <- ny_predicted_proficiency %>%
    dplyr::filter(
      ny_subj == measurementscale,
      ny_grade == current_grade,
      ny_season == season,
      ny_rit == RIT
    )
  
  if (nrow(out)==0) {
    if (returns == 'perf_level') {
      out <- NA_character_  
    } else if (returns == 'proficient') {
      out <- NA
    }
  } else {
    out <- out[, returns] %>% unlist %>% unname()  
  }
  
  out 
}
almartin82/mapvizieR documentation built on June 3, 2023, 10:53 a.m.