List the tables a module publishes

Usage

tg_tables(module = NULL, counts = FALSE)

tg_tabelas(modulo = NULL, contagens = FALSE)

Arguments

module: A module name from tg_modules(). Aliases such as "fundo_a_fundo" are accepted. NULL lists the tables of every module.
counts: If TRUE, adds a rows column with the number of rows each table currently holds. This is the only part of this function that needs a network connection: it makes one request per table, so tg_tables(counts = TRUE) with no module makes fifty-five. Responses are cached.
modulo: Portuguese alias for module, available in tg_tabelas() and tg_campos().
contagens: Portuguese alias for counts, available only in tg_tabelas().

Value

A tibble with one row per table: its module, name, the endpoint path it maps to, its number of columns and filterable parameters, and the description published in the API schema. With counts = TRUE, also the current number of rows.

Examples

tg_tables("parcerias")
#> # A tibble: 15 × 6
#>    module    table                           path     columns params description
#>    <chr>     <chr>                           <chr>      <int>  <int> <chr>      
#>  1 parcerias analise_proposta                analise…       7      5 Retorna um…
#>  2 parcerias beneficiario_emenda_parlamentar benefic…      16     14 Retorna um…
#>  3 parcerias cronograma_desembolso           cronogr…       7      7 Retorna um…
#>  4 parcerias distribuicao_recurso_proposta   distrib…       8      8 Retorna um…
#>  5 parcerias documento_habil                 documen…      15     15 Retorna um…
#>  6 parcerias empenho_parceria                empenho…      24     24 Retorna um…
#>  7 parcerias extrato_bancario                extrato…      13     13 Retorna um…
#>  8 parcerias item_proposta                   item-pr…      14     13 Retorna um…
#>  9 parcerias meta_proposta                   meta-pr…       6     12 Retorna um…
#> 10 parcerias ordem_pagamento                 ordem-p…      11     11 Retorna um…
#> 11 parcerias parceria                        parceria      16     20 Retorna um…
#> 12 parcerias parceria_conta                  parceri…      23     28 Retorna um…
#> 13 parcerias programa                        programa      51     52 Retorna um…
#> 14 parcerias proposta                        proposta      43     45 Retorna um…
#> 15 parcerias proposta_resultado_indicador    propost…       6      6 Retorna um…
tg_tables()
#> # A tibble: 55 × 6
#>    module    table                              path  columns params description
#>    <chr>     <chr>                              <chr>   <int>  <int> <chr>      
#>  1 especiais beneficiarios_especiais            bene…       5      5 Retorna um…
#>  2 especiais documentos_habeis_especiais        docu…      25     25 Retorna um…
#>  3 especiais empenhos_especiais                 empe…      24     24 Retorna um…
#>  4 especiais executores_especiais               exec…      17     17 Retorna um…
#>  5 especiais finalidade_especiais               fina…       5      5 Retorna um…
#>  6 especiais gestao_financeira_lancamentos_esp… gest…      34     30 Retorna um…
#>  7 especiais gestao_financeira_subtransacoes_e… gest…      14     12 Retorna um…
#>  8 especiais meta_especiais                     meta…      16     16 Retorna um…
#>  9 especiais ordens_pagamentos_ordens_bancaria… orde…      13     13 Retorna um…
#> 10 especiais orgaos_analises_pendentes_especia… orga…       4      4 Retorna um…
#> # ℹ 45 more rows

if (interactive()) {
  # How big is everything, largest first?
  sizes <- tg_tables(counts = TRUE)
  sizes[order(-sizes$rows), ]
}

List the tables a module publishes

Usage

Arguments

Value

See also

Examples