R/fall_spring_me.R

In almartin82/MAP-visuals: KIPP MAP Visuals

#' @title Fall-Spring Me
#'
#' @description
#' \code{fall_spring_me} tranforms grade levels into labels for charts; eg 4.2 -> F5
#'
#' @param grade_level a grade level between -1 and 12
#' 
#' @return a string
#' @export

fall_spring_me <- function(grade_level) {
  #K is weird edge case
  if(grade_level == -0.8) {
    return('KF')
  } else if(grade_level == -0.5) {
    return('KW')
  } else if(grade_level == 0) {
    return('KS')
  #too small, return nothing
  } else if(grade_level <= -1) {
    return('')
  #too big
  } else if(grade_level > 12) {
    return('')  
  #S observations are decimal 0s
  } else if(grade_level %% 1 == 0) {
    return(paste0(round(grade_level, 0), 'S'))
  #test for F and W
  } else if(round(grade_level %% 1,1) == 0.2) {
    return(paste0(ceiling(grade_level), 'F'))
  } else if(round(grade_level %% 1,2) == 0.5) {
    return(paste0(ceiling(grade_level), 'W'))
  } else {
    return(NA)
  }
}