
# ============================================================
# EVOLUCAO TEMPORAL DA RELACAO ENTRE OS EFETIVOS OVINOS
# E CAPRINOS NAS GRANDES REGIOES BRASILEIRAS (2015-2025)
#
# SCRIPT 03 - MODELAGEM GLS E CONTRASTES REGIONAIS
#
# AUTORES:
# A confirmar antes do deposito no Zenodo
#
# INSTITUICAO:
# Universidade Federal de Alagoas (UFAL)
# Campus de Engenharias e Ciencias Agrarias (CECA)
# Rio Largo, Alagoas, Brasil
#
# FONTE:
# IBGE / SIDRA - Pesquisa da Pecuaria Municipal
# Tabela 3939
#
# ENTRADA:
# resultados/banco_ovinos_caprinos_2015_2025.csv
#
# SAIDAS:
# resultados/Tabela_Inclinacoes_GLS.csv
# resultados/Tabela_Contrastes_GLS.csv
# resultados/Teste_Interacao_GLS.csv
# resultados/Parametros_GLS.csv
#
# ============================================================


# 1. PACOTES
# ------------------------------------------------------------

pacotes <- c(
  "dplyr",
  "nlme",
  "emmeans"
)

faltantes <- pacotes[
  !vapply(
    pacotes,
    requireNamespace,
    logical(1),
    quietly = TRUE
  )
]

if (length(faltantes) > 0) {
  install.packages(faltantes)
}

invisible(
  lapply(pacotes, library, character.only = TRUE)
)


# 2. DIRETORIOS E ARQUIVO DE ENTRADA
# ------------------------------------------------------------

# Executar a partir da pasta principal do projeto.
# O Script 01 deve ter sido executado anteriormente.

pasta_resultados <- "resultados"

arquivo_banco <- file.path(
  pasta_resultados,
  "banco_ovinos_caprinos_2015_2025.csv"
)

if (!file.exists(arquivo_banco)) {
  stop(
    "Banco longitudinal nao encontrado: ",
    arquivo_banco,
    "\nExecute primeiro o Script 01."
  )
}


# 3. IMPORTACAO DO BANCO LONGITUDINAL
# ------------------------------------------------------------

dados <- utils::read.csv(
  arquivo_banco,
  stringsAsFactors = FALSE,
  fileEncoding = "UTF-8",
  check.names = FALSE
)

variaveis_obrigatorias <- c(
  "regiao",
  "ano",
  "ovinos",
  "caprinos",
  "razao_oc",
  "tempo"
)

if (!all(
  variaveis_obrigatorias %in% names(dados)
)) {
  stop(
    "O banco nao contem todas as variaveis ",
    "necessarias para a modelagem GLS."
  )
}


# 4. AUDITORIA DO BANCO
# ------------------------------------------------------------

ordem_regioes <- c(
  "Norte",
  "Nordeste",
  "Centro-Oeste",
  "Sudeste",
  "Sul"
)

stopifnot(
  nrow(dados) == 55,
  dplyr::n_distinct(dados$regiao) == 5,
  dplyr::n_distinct(dados$ano) == 11,
  setequal(unique(dados$regiao), ordem_regioes),
  setequal(unique(dados$ano), 2015:2025),
  all(table(dados$regiao) == 11),
  !anyNA(dados[, variaveis_obrigatorias]),
  all(dados$ovinos > 0),
  all(dados$caprinos > 0),
  all(dados$razao_oc > 0),
  !anyDuplicated(dados[c("regiao", "ano")])
)

stopifnot(
  isTRUE(
    all.equal(
      dados$razao_oc,
      dados$ovinos / dados$caprinos,
      tolerance = 1e-10
    )
  ),
  isTRUE(
    all.equal(
      dados$tempo,
      dados$ano - 2015,
      tolerance = 1e-10
    )
  )
)


# 5. PREPARACAO PARA A MODELAGEM GLS
# ------------------------------------------------------------

dados <- dados %>%
  dplyr::mutate(
    regiao = factor(
      regiao,
      levels = ordem_regioes
    ),
    log_oc = log(razao_oc)
  ) %>%
  dplyr::arrange(regiao, tempo)

cat("\n====================================\n")
cat("AUDITORIA DO BANCO - GLS\n")
cat("====================================\n")

cat("Observacoes:", nrow(dados), "\n")
cat("Regioes:", nlevels(dados$regiao), "\n")
cat(
  "Periodo:",
  min(dados$ano),
  "-",
  max(dados$ano),
  "\n"
)

cat("Auditoria estrutural: APROVADA\n")


# 6. MODELO GLS COMPLETO
# ------------------------------------------------------------

# Modelo:
#
# log(O/C) = regiao + tempo + regiao:tempo + erro
#
# Estrutura residual:
# - Autocorrelacao AR(1) dentro de cada regiao
# - Variancias residuais heterogeneas entre regioes
#
# Estimacao: maxima verossimilhanca (ML)

controle_gls <- nlme::glsControl(
  maxIter = 200,
  msMaxIter = 200,
  tolerance = 1e-8
)

modelo_gls <- nlme::gls(
  log_oc ~ regiao * tempo,
  
  data = dados,
  
  correlation = nlme::corAR1(
    form = ~ tempo | regiao
  ),
  
  weights = nlme::varIdent(
    form = ~ 1 | regiao
  ),
  
  method = "ML",
  
  control = controle_gls
)

cat("\n====================================\n")
cat("MODELO GLS COMPLETO\n")
cat("====================================\n")

print(summary(modelo_gls))


# 7. MODELO GLS SEM INTERACAO
# ------------------------------------------------------------

# Modelo reduzido:
#
# log(O/C) = regiao + tempo + erro
#
# A estrutura residual e o metodo de estimacao
# sao mantidos para permitir comparacao por
# teste da razao de verossimilhancas.

modelo_sem_interacao <- nlme::gls(
  log_oc ~ regiao + tempo,
  
  data = dados,
  
  correlation = nlme::corAR1(
    form = ~ tempo | regiao
  ),
  
  weights = nlme::varIdent(
    form = ~ 1 | regiao
  ),
  
  method = "ML",
  
  control = controle_gls
)


# 8. TESTE GLOBAL DA INTERACAO
# ------------------------------------------------------------

# Hipotese nula:
# As cinco regioes apresentam a mesma
# inclinacao temporal na escala logaritmica.
#
# Hipotese alternativa:
# Pelo menos uma inclinacao regional difere.
#
# Comparacao entre modelos aninhados por
# teste da razao de verossimilhancas (LRT).

teste_interacao <- stats::anova(
  modelo_sem_interacao,
  modelo_gls
)

cat("\n====================================\n")
cat("TESTE GLOBAL DA INTERACAO REGIAO x TEMPO\n")
cat("====================================\n")

print(teste_interacao)

tabela_interacao <- as.data.frame(
  teste_interacao
)

tabela_interacao$modelo <- rownames(
  tabela_interacao
)

rownames(tabela_interacao) <- NULL


# 9. INCLINACOES TEMPORAIS REGIONAIS
# ------------------------------------------------------------

# Estimativas das inclinacoes temporais
# para cada regiao na escala log(O/C).
#
# Os intervalos de confianca sao derivados
# do modelo GLS completo.

tendencias <- emmeans::emtrends(
  modelo_gls,
  specs = ~ regiao,
  var = "tempo"
)

tabela_tendencias <- as.data.frame(
  summary(
    tendencias,
    infer = c(TRUE, TRUE),
    level = 0.95
  )
)

cat("\n====================================\n")
cat("INCLINACOES TEMPORAIS REGIONAIS - GLS\n")
cat("====================================\n")

print(
  tabela_tendencias,
  row.names = FALSE
)


# 10. CONTRASTES ENTRE INCLINACOES REGIONAIS
# ------------------------------------------------------------

# Comparacoes par a par entre as cinco
# inclinacoes temporais regionais.
#
# Ajuste de multiplicidade:
# mvt - distribuicao t multivariada.
#
# Correcao:
# pairs() e um generico de base R.
# Nao utilizar emmeans::pairs().

contrastes <- pairs(
  tendencias,
  adjust = "mvt"
)

tabela_contrastes <- as.data.frame(
  summary(
    contrastes,
    infer = c(TRUE, TRUE),
    level = 0.95
  )
)

cat("\n====================================\n")
cat("CONTRASTES ENTRE INCLINACOES - GLS\n")
cat("====================================\n")

print(
  tabela_contrastes,
  row.names = FALSE
)


# 11. PARAMETROS DO MODELO GLS
# ------------------------------------------------------------

# Parametro de autocorrelacao AR(1).

rho <- as.numeric(
  stats::coef(
    modelo_gls$modelStruct$corStruct,
    unconstrained = FALSE
  )
)

# Razoes de desvio-padrao residual
# relativas a regiao de referencia.

coef_variancias <- stats::coef(
  modelo_gls$modelStruct$varStruct,
  unconstrained = FALSE
)

# Desvio-padrao residual de referencia.

sigma_residual <- modelo_gls$sigma

tabela_parametros <- data.frame(
  parametro = c(
    "rho_AR1",
    "sigma_residual",
    names(coef_variancias)
  ),
  
  estimativa = c(
    rho,
    sigma_residual,
    as.numeric(coef_variancias)
  ),
  
  stringsAsFactors = FALSE
)

cat("\n====================================\n")
cat("PARAMETROS DA ESTRUTURA RESIDUAL\n")
cat("====================================\n")

print(
  tabela_parametros,
  row.names = FALSE
)


# 12. CONFERENCIAS NUMERICAS DE REFERENCIA
# ------------------------------------------------------------

# Valores previamente obtidos na analise.
# Utilizados apenas para identificar possiveis
# divergencias de reproducao.
#
# Estas conferencias nao alteram estimativas.

rho_referencia <- 0.4109835

if (
  abs(rho - rho_referencia) > 0.001
) {
  warning(
    "O parametro rho difere do valor ",
    "de referencia previamente registrado."
  )
}

inclinacoes_referencia <- c(
  "Norte"        = 0.017958215,
  "Nordeste"     = 0.002713779,
  "Centro-Oeste" = 0.001703732,
  "Sudeste"      = 0.001956420,
  "Sul"          = 0.051170888
)

inclinacoes_observadas <- stats::setNames(
  tabela_tendencias$tempo.trend,
  as.character(tabela_tendencias$regiao)
)

diferencas <- abs(
  inclinacoes_observadas[
    names(inclinacoes_referencia)
  ] - inclinacoes_referencia
)

if (
  anyNA(diferencas) ||
  any(diferencas > 0.001)
) {
  warning(
    "Uma ou mais inclinacoes GLS diferem ",
    "dos valores de referencia."
  )
}


# 13. EXPORTACAO DOS RESULTADOS
# ------------------------------------------------------------

utils::write.csv(
  tabela_tendencias,
  
  file = file.path(
    pasta_resultados,
    "Tabela_Inclinacoes_GLS.csv"
  ),
  
  row.names = FALSE,
  fileEncoding = "UTF-8"
)

utils::write.csv(
  tabela_contrastes,
  
  file = file.path(
    pasta_resultados,
    "Tabela_Contrastes_GLS.csv"
  ),
  
  row.names = FALSE,
  fileEncoding = "UTF-8"
)

utils::write.csv(
  tabela_interacao,
  
  file = file.path(
    pasta_resultados,
    "Teste_Interacao_GLS.csv"
  ),
  
  row.names = FALSE,
  fileEncoding = "UTF-8"
)

utils::write.csv(
  tabela_parametros,
  
  file = file.path(
    pasta_resultados,
    "Parametros_GLS.csv"
  ),
  
  row.names = FALSE,
  fileEncoding = "UTF-8"
)


# 14. VERIFICACAO DOS ARQUIVOS EXPORTADOS
# ------------------------------------------------------------

arquivos_saida <- file.path(
  pasta_resultados,
  c(
    "Tabela_Inclinacoes_GLS.csv",
    "Tabela_Contrastes_GLS.csv",
    "Teste_Interacao_GLS.csv",
    "Parametros_GLS.csv"
  )
)

if (!all(file.exists(arquivos_saida))) {
  stop(
    "Um ou mais arquivos GLS nao foram gerados."
  )
}

if (any(file.info(arquivos_saida)$size <= 0)) {
  stop(
    "Um ou mais arquivos GLS estao vazios."
  )
}


# 15. FINALIZACAO
# ------------------------------------------------------------

cat("\n====================================\n")
cat("SCRIPT 03 - MODELAGEM GLS CONCLUIDA\n")
cat("====================================\n")

cat("Observacoes:", nrow(dados), "\n")
cat("Regioes:", nlevels(dados$regiao), "\n")

cat(
  "Periodo:",
  min(dados$ano),
  "-",
  max(dados$ano),
  "\n"
)

cat("\nModelo:\n")
cat("- GLS com interacao regiao x tempo\n")
cat("- Correlacao residual AR(1)\n")
cat("- Variancias heterogeneas por regiao\n")
cat("- Estimacao por ML\n")
cat("- Contrastes com ajuste mvt\n")

cat("\nArquivos exportados:\n")
cat("- Tabela_Inclinacoes_GLS.csv\n")
cat("- Tabela_Contrastes_GLS.csv\n")
cat("- Teste_Interacao_GLS.csv\n")
cat("- Parametros_GLS.csv\n")

cat("\nPasta:", pasta_resultados, "\n")
cat("====================================\n")
