R/identifypd.R

In ICPI/ICPIutilities: Utility functions for working with or creating ICPI products

#' Extract lastest period of dataset
#' @description This function is pulled from the achafetz/PartnerProgress repo
#' @param df dataset to use to find latest period
#' @param pd_type what is returned? (a) full, eg fy2018q1; (b)year, eg 2018; (c) quarter, eg 1
#' @param pd_prior do you want the last period returned (instead of the current); default = FALSE
#'
#' @export
#'
#' @importFrom dplyr %>%
#'
#' @examples
#' \dontrun{
#' #return full, current period, eg "fy2018q3"
#' identifypd(df_mer)
#' #return the current quarter, eg 3
#' identifypd(df_mer, "quarter")
#' #return the prior quarter, eg "fy2018q2"
#' identifypd(df_mer, pd_prior = TRUE)
#'   }
#'
identifypd <- function(df, pd_type = "full", pd_prior = FALSE) {

  .Deprecated(msg = "Functions in ICPIutilities are no longer being maintained\n and have been transfered to gophr. Install gophr via\n remotes::install_github('USAID-OHA-SI/gophr')")

  #get header names based on new or old structure
    if(any(stringr::str_detect(names(df), "(Q|q)tr1"))){

      #figure out whether to make FY upper or lower, depending on the case of Qtr
      fy_case <- ifelse(any(stringr::str_detect(names(df), "Q")), "FY", "fy")

      headers <- df %>%
        dplyr::group_by(fiscal_year) %>%
        dplyr::summarise_at(dplyr::vars(dplyr::matches("(Q|q)tr")), sum, na.rm = TRUE) %>%
        dplyr::mutate_all(~dplyr::na_if(., 0)) %>%
        tidyr::pivot_longer(dplyr::matches("[Q|q]"),
                            names_to = "qtr",
                            names_prefix = "qtr",
                            values_drop_na = TRUE) %>%
        tidyr::unite(pd, c("fiscal_year", "qtr"), sep = "Q") %>%
        dplyr::mutate(pd = stringr::str_replace(pd, "20", "FY")) %>%
        dplyr::arrange(pd) %>%
        dplyr::pull(pd)

    } else if("period" %in% names(df)) {
      headers <- df %>%
        dplyr::distinct(period) %>%
        dplyr::filter(stringr::str_detect(period, "Q")) %>%
        dplyr::arrange(period) %>%
        dplyr::pull()
    } else {
      stop("Unable to process structure.")
    }

  #pull current (last column) or prior (2nd to last column)
  pos = dplyr::case_when(pd_prior == FALSE                    ~ -1, #pull last col, curr pd
                         pd_prior == TRUE &&
                           !pd_type %in% c("target", "year")  ~ -2, #pull 2nd to last col, last pd
                         TRUE                                 ~ -5) #pull 5 quarters ago, push year to 1 prior

  #figure out column, keeping only variables that are a quarter
  pd <- headers[stringr::str_detect(headers, "[q|Q](?=[:digit:])")] %>%
    dplyr::nth(pos)
  #extract different portions of the the last column based on pd_type
  if(pd_type == "year") {
    pd <- stringr::str_sub(pd, start = 3, end = 4) %>%
      paste0("20", .) %>%
      as.integer(.)
  } else if(pd_type == "quarter") {
    pd <- stringr::str_sub(pd, start = -1) %>%
      as.integer(.)
  } else {
    pd
  }

  return(pd)
}