--- title: "Putting the tables back together" output: rmarkdown::html_vignette vignette: > %\VignetteIndexEntry{Putting the tables back together} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- ```{r, include = FALSE} knitr::opts_chunk$set(collapse = TRUE, comment = "#>", eval = FALSE) ``` Each module is a normalized database served one table at a time. Almost nothing useful is answerable from a single table: the money is in one, who received it in another, and what it was spent on in a third. This vignette maps how they fit together. ```{r} library(transferegovr) library(dplyr) ``` ## The APIs do not declare their keys The OpenAPI documents these services publish describe columns and query parameters, and nothing else — no primary keys, no foreign keys. `tg_fields()` therefore cannot tell you what joins to what. The relationships below come from the data models the government publishes alongside the APIs, at . The convention is regular enough to follow without them: a column named `id_x` in table B refers to the row of table X whose own `id_x` matches. ## especiais Everything hangs off the action plan, `planos_acao_especiais`. ``` programas_especiais ──< planos_acao_especiais >── beneficiarios_especiais │ ├──< planos_trabalho_especiais │ ├──< planos_trabalho_analises_especiais │ │ └──< plano_trabalho_analise_historico_especiais │ ├──< planos_trabalho_historico │ └──< orgaos_analises_pendentes_especiais ├──< executores_especiais │ ├──< meta_especiais │ └──< finalidade_especiais ├──< empenhos_especiais │ └──< documentos_habeis_especiais │ └──< ordens_pagamentos_ordens_bancarias_especiais ├──< planos_acao_historico_especiais ├──< relatorios_gestao_especiais └──< relatorios_gestao_novos_especiais saldo_conta_gestao_financeira_especiais ──< gestao_financeira_lancamentos_especiais └──< gestao_financeira_subtransacoes_especiais ``` The join columns are the obvious ones: `id_plano_acao`, `id_plano_trabalho`, `id_executor`, `id_empenho`, `id_dh`, `id_beneficiario`, `id_programa`, `id_agencia_conta`, `id_lancamento_gestao_financeira`. The goals and the public-policy area hang off the executor rather than off the plan: `meta_especiais` and `finalidade_especiais` both key on `id_executor`. Note where the beneficiary lives. The action plan carries only `id_beneficiario`; the name, CNPJ and state are in `beneficiarios_especiais`. There is no way to filter action plans by state directly — you filter the beneficiaries and join: ```{r} beneficiarios <- tg_get("especiais", "beneficiarios_especiais", .limit = Inf) pernambuco <- beneficiarios |> filter(uf_beneficiario == "PE") planos <- tg_get("especiais", "planos_acao_especiais", .limit = Inf) |> semi_join(pernambuco, by = "id_beneficiario") ``` `beneficiarios_especiais` has five columns and is small enough to take whole, which makes this cheaper than it looks. ## fundoafundo Same shape, with the program at the top. ``` programas ──< planos_acao ├──< programas_beneficiarios │ └──< programas_gestao_agil ├──< planos_acao_metas │ └──< planos_acao_metas_acoes ├──< planos_acao_dados_bancarios ├──< planos_acao_destinacao_recursos ├──< planos_acao_historico │ └──< planos_acao_analises │ └──< planos_acao_analises_responsaveis ├──< termos_adesao │ └──< termos_adesao_historico ├──< empenhos └──< relatorios_gestao ├──< relatorios_gestao_acoes └──< relatorios_gestao_analises └──< relatorios_gestao_analises_responsaveis gestao_financeira_lancamentos ──< gestao_financeira_subtransacoes ``` Here the action plan does carry the state, so a filter does the work the join would: ```{r} planos <- tg_get( "fundoafundo", "planos_acao", uf_ente_recebedor_plano_acao = "PE", .limit = Inf ) ``` `relatorios_gestao_acoes` joins two ways — to its report through `id_relatorio_gestao` and to the plan's action through `id_acao_meta_plano_acao` — which is what lets you tie what was reported to what was planned. ## parcerias The chain here is the longest, and it is the one worth following end to end: it runs from the program that announces money to the bank statement of the account it leaves from. ``` programa ──< proposta ──< parceria ──< parceria_conta ──< extrato_bancario │ │ │ │ │ └──< documento_habil ──< ordem_pagamento │ │ └──< empenho_parceria │ ├──< meta_proposta │ ├──< item_proposta │ ├──< cronograma_desembolso │ ├──< distribuicao_recurso_proposta │ ├──< proposta_resultado_indicador │ └──< analise_proposta └──< beneficiario_emenda_parlamentar ``` Following it: ```{r} propostas <- tg_get( "parcerias", "proposta", sg_uf_recebedor = "PE", situacao_proposta = "Aprovada", .limit = Inf ) parcerias <- tg_get("parcerias", "parceria", .limit = Inf) |> semi_join(propostas, by = "id_proposta") contas <- tg_get("parcerias", "parceria_conta", .limit = Inf) |> semi_join(parcerias, by = "id_parceria") ``` `extrato_bancario` holds 1.1 million rows, so join into it rather than collecting it whole — filter by the account you care about: ```{r} library(purrr) extratos <- list_rbind(map(contas$id_parceria_conta, function(id) { tg_get("parcerias", "extrato_bancario", id_parceria_conta = id, .limit = Inf) })) ``` ## Children that arrive already joined Several child tables have no endpoint. The API folds them into the parent as an array, which means the join is already done and you only have to unnest. In `parcerias`: | Nested column | Parent | What it holds | |---|---|---| | `ufs_habilitadas` | `programa` | States the program is open to | | `programa_atende_a` | `programa` | Who the program serves | | `categorias_despesa` | `programa` | Permitted expense categories | | `resultados_esperados` | `programa` | Expected results | | `indicadores_programa` | `programa` | Indicators | | `intervenientes_proposta` | `proposta` | Intervening parties | | `categorias_despesa_proposta` | `proposta` | Expense categories used | | `etapas_proposta` | `meta_proposta` | Stages of a goal | | `publicacoes_parceria` | `parceria` | Official gazette publications | | `classificacoes_ingresso` | `parceria_conta` | Classified receipts | | `tipos_analise` | `analise_proposta` | Kinds of review | | `indicacoes_beneficiario` | `beneficiario_emenda_parlamentar` | Nominations | | `classificacao_despesa` | `item_proposta` | Expense classification | In `fundoafundo`: `programa_acao_orcamentaria` and `programa_natureza_despesa` on `programas`, `categorias_despesa_lancamento` on `gestao_financeira_lancamentos`, and `categorias_despesa_subtransacao` on `gestao_financeira_subtransacoes`. `especiais` has none: all twenty of its tables have endpoints. To flatten one: ```{r} library(tidyr) programas <- tg_get("parcerias", "programa", .limit = Inf) programas |> select(id_programa, ufs_habilitadas) |> unnest_longer(ufs_habilitadas) |> unnest_wider(ufs_habilitadas) #> # A tibble: … × 4 #> id_programa nm_uf sg_uf cd_ibge #> #> 1 7 MINAS GERAIS MG 31 #> … ``` `tg_fields(nested = )` tells you the shape before you unnest: ```{r} tg_fields("parcerias", "programa", nested = "ufs_habilitadas") ``` Note that an empty array is an empty list, not `NA`, so `unnest_longer()` drops those rows unless you ask it to keep them with `keep_empty = TRUE`. ## Joins that do not fully resolve Not every identifier finds its parent. Government systems have rows that predate a constraint, and rows whose parent has since been removed. Check rather than assume: ```{r} planos <- tg_get("especiais", "planos_acao_especiais", .limit = 500) beneficiarios <- tg_get("especiais", "beneficiarios_especiais", .limit = Inf) sum(!planos$id_beneficiario %in% beneficiarios$id_beneficiario) ``` An `inner_join()` would drop those rows silently. Use `left_join()` and count the `NA`s, or `anti_join()` to see what did not match, so a gap upstream shows up as a number rather than as a quietly smaller answer. ## Repeated identifiers are not always a bug Some endpoints are views with a join already baked in, so an identifier can appear on more than one row. That is real data, not a pagination fault — it can be told apart by fetching a single page and checking whether the repeat is already there: ```{r} one_page <- tg_get("fundoafundo", "programas", .limit = 200) nrow(one_page) length(unique(one_page$id_programa)) ``` If the two differ within one request, no amount of pagination caused it.