Pacote R para download, processamento, validação, auditoria e diagnóstico dos dados do VIGIAR (Vigilância em Saúde Ambiental) do Ministério da Saúde, com foco no estado do Rio de Janeiro (92 municípios e 9 macrorregiões de saúde SES-RJ).
O vigiar desconfia dos dados antes de seduzir o pesquisador com gráficos.
O que o pacote faz
O pacote segue a arquitetura:
fonte externa (Power BI)
→ aquisição (vigiar_conectar, vigiar_baixar)
→ validação (vigiar_validar_*, vigiar_checar_*)
→ processamento (process_*)
→ auditoria (vigiar_auditar, vigiar_compliance_check)
→ diagnóstico (vigiar_diagnosticar_serie)
→ reprodutibilidade (snapshots, checksums, schema lock)
Ele disponibiliza:
- concentração de PM2.5 por município (séries anuais e mensais);
- dias acima dos limites da OMS e do CONAMA;
- população exposta por faixa de concentração;
- indicadores de saúde (fração atribuível, desfechos);
- exposição indoor a combustíveis sólidos;
- cadastro oficial dos 92 municípios do Rio de Janeiro e das macrorregiões de saúde;
- dicionário de variáveis consultável, com auditoria de cobertura documental.
Qualidade e confiabilidade
O pacote trata a qualidade dos dados — e do próprio código — como parte do resultado. Todos esses controles rodam no CI a cada alteração:
| Controle | O que garante |
|---|---|
R CMD check |
Linux (release, devel, oldrel-1), macOS e Windows, sem ERRORs. |
R CMD check --as-cran |
Verificações adicionais de submissão (incoming). |
test-coverage |
Cobertura de ~90%, com ratchet por arquivo que falha em regressões. |
lint |
lintr bloqueante (0 lints tolerados). |
pkgdown |
Site e e-book renderizam a cada push. |
version-consistency |
DESCRIPTION, CITATION.cff e codemeta.json sempre em sincronia. |
| testes online agendados | O contrato de conexão com o dashboard real é validado semanalmente. |
Além disso:
-
Toda a API pública tem exemplos executáveis (
@examples) — conexão/rede usam\dontrun{}; o restante roda offline com o dado de exemplo embutido. -
vigiar_lifecycle()informa o status (estável/experimental) de cada função exportada, e um teste garante que todo export está registrado. - O dicionário de variáveis é auditável:
vigiar_variaveis_nao_documentadas()evigiar_variaveis_orfas()comparam a documentação com o esquema ao vivo.
Origem dos dados
Os dados são públicos e disponibilizados pelo VIGIAR (Ministério da Saúde) por meio de um dashboard Power BI “Publish to Web” (acesso anônimo, sem login). O pacote não é oficial do Ministério da Saúde.
A disponibilidade, a URL e o esquema (tabelas/colunas) da fonte externa podem mudar independentemente do pacote. O pacote tenta detectar essas mudanças (vigiar_status(), vigiar_esquema_verificar()) e falhar com mensagens claras, mas o acesso programático é engenharia reversa de um endpoint interno e não contratual do Power BI. Consulte a vinheta de uso responsável.
Instalação
O pacote é distribuído pelo GitHub (não está no CRAN).
install.packages("remotes")
remotes::install_github("santosry/vigiar")Requer R >= 4.1.0 e acesso à internet para as funções de download. O processamento, a validação e a auditoria funcionam offline.
Uso mínimo
library(vigiar)
# 1. Conecta ao dashboard (requer internet)
vigiar_conectar()
# 2. Lista tabelas e baixa dados
vigiar_tabelas()
df_anual <- vigiar_baixar("df_anual")
# 3. Processa e valida
pm25 <- process_pm25(df_anual, tipo = "anual")
vigiar_checar_dados(pm25, tabela = "df_anual")
# 4. Diagnostica a série temporal do RJ
diag <- vigiar_diagnosticar_serie(pm25, escopo = "rj")
vigiar_relatorio_diagnostico(diag)
# 5. Encerra a sessão
vigiar_desconectar()Sem internet
Para conhecer o pacote (e rodar os exemplos) sem conexão, use o dado sintético incluído:
library(vigiar)
data(pm25_rj_sample)
summary(pm25_rj_sample)
diag <- vigiar_diagnosticar_serie(pm25_rj_sample, escopo = "rj")
print(diag)
# Quais funções são estáveis?
vigiar_lifecycle()Documentação completa
Toda a documentação — instalação, guia de uso, qualidade/testes, exemplos, auditoria, reprodutibilidade e limitações — está no e-book do vigiar. As vinhetas (vignette(package = "vigiar")) cobrem convenções de variáveis, fluxo de download/processamento e uso responsável dos dados.
Desenvolvimento
# Carregar e rodar os testes (offline, determinísticos)
devtools::load_all()
devtools::test()
# Cobertura (a mesma checagem do CI, com ratchet)
# Rscript .github/coverage-check.R
# Estilo e lint
lintr::lint_package()O CI fixa as GitHub Actions por SHA e usa dependabot para mantê-las atualizadas.
Limitações
- PM2.5 é estimado por satélite/modelagem, não medido em superfície.
- População exposta usa projeções do IBGE, não contagens censitárias.
- Indicadores de saúde são estimativas epidemiológicas com intervalo de confiança.
- Os dados são agregados por município/ano — não há dados individuais.
- O dashboard do Power BI pode ficar temporariamente indisponível ou mudar de esquema.