R/get_rgf.R

In tchiluanda/rsiconfi: Accounting Data of Brazilian Public Sector

#' Get Fiscal Managment Data
#'
#' @description
#' Get data related to fiscal management reports of a given set of entities of the public brazilian sector, filtered by a set of parameters passed to the function.
#' For more information about these reports, please see https://siconfi.tesouro.gov.br/siconfi/pages/public/conteudo/conteudo.jsf?id=82

#' @param year a numeric vector
#' @param periodicity character. Available values: Q, S
#' @param period a numeric vector. Available values: 1, 2, 3
#' @param report_tp numeric. Available values: 1- RGF, 2-RGF Simplificado
#' @param annex character
#' @param entity a character vector. IBGE code of a public sector entities set.
#' @param co_power a character vector.Available values:  E = Executivo, L = Legislativo, J = Judiciário, M = Ministério Público, D = Defensoria Pública
#'
#' @return dataframe
#' @export
#'
#' @examples
#' get_rgf(year=  c(2018),  periodicity = "Q",  period =  1,    report_tp = 1,      annex = "02",       entity = c("2312908"),   co_power = "E")
get_rgf<- function(year, periodicity, period, report_tp, annex, entity, co_power ){

  library(dplyr)
  library(purrr)
  library(stringr)
  library(jsonlite)


  #test if some variables have just one element

  if (length(report_tp)>1){
    stop("Must inform just one report type")
  }

  if (length(annex)>1){
    stop("Must inform just one annex")
  }

  if (length(periodicity)>1){
    stop("Must inform just one periodicity")
  }

  #test some business rules

  if(report_tp>2 ){
    stop("Wrong report type")
  }

  if(!(periodicity %in% c("Q","S"))){
    stop("Wrong periodicity")
  }


  if (periodicity == "S" && period >2){
    stop("Wrong period")
  }

  if (period >3){
    stop("Wrong period")
  }

  if (!(co_power %in% c("E","L","J","M","D") )){
    stop("Wrong power code")

  }

  df_esf_entidade = tibble(entidade = entity )

  df_esf_entidade<-df_esf_entidade%>%
    mutate(esfera= case_when(
      str_length(entity)== 1 ~"U",
      str_length(entity)== 2 ~"E",
      str_length(entity)== 7 ~"M"
    ) )



  annex_txt<-paste0("RGF-Anexo ",annex)

  test<- df_esf_entidade %>%
    anti_join(df_reports%>%
                filter(anexo==annex_txt))

  if (NROW(test)>0){
    stop("One or more entities not suitable for the annex informed")
  }


  map_df(year, function(ref_year){

    map_df(period, function(ref_per){

      map_df(entity, function(ref_entity){

        map_df(co_power, function(ref_power){

          base_address<- "http://apidatalake.tesouro.gov.br/ords/siconfi/tt/rgf"
          annex_conv<-paste0("RGF-Anexo%20",annex)

          exp<- paste0(base_address,
                       "?an_exercicio=", ref_year,
                       "&in_periodicidade=", periodicity,
                       "&nr_periodo=", ref_per,
                       "&co_poder=", ref_power,
                       "&co_tipo_demonstrativo=", c("RGF", "RGF+Simplificado")[report_tp],
                       "&no_anexo=", annex_conv,
                       "&id_ente=",ref_entity)

          #print(exp)

          ls_siconfi<-jsonlite::fromJSON(exp)


          #print(ls_siconfi$count)
          if (ls_siconfi$count==0){
            return (tibble())
          }
          df_siconfi<- ls_siconfi[["items"]]

          df_siconfi$valor <- as.numeric(df_siconfi$valor)

          df_siconfi


        })

      })

    })
  })

}