Skip to contents

Session

vigiar_conectar()
Connect to the VIGIAR Power BI dashboard
vigiar_desconectar()
Disconnect and clear VIGIAR session
vigiar_sessao_ativa()
Check if a VIGIAR session is active
vigiar_status()
Check VIGIAR dashboard status
vigiar_client()
Create a VIGIAR Power BI client

Download

vigiar_tabelas()
List available tables
vigiar_esquema()
Display table schema
vigiar_info()
Table catalogue with descriptions
vigiar_baixar()
Download data from a single table
vigiar_baixar_tudo()
Download multiple tables
vigiar_baixar_principais()
Download main tables (convenience shortcut)
vigiar_baixar_rj()
Download Rio de Janeiro VIGIAR data (convenience)

Processing

process_vigiar()
Process VIGIAR data – generic dispatcher
process_pm25()
Process PM2.5 air quality data
process_populacao_exposta()
Process population exposure data
process_indicadores_saude()
Process health indicators data
process_fracao_atribuivel()
Process attributable fraction data
process_exposicao_indoor()
Process indoor exposure data
process_municipios()
Process municipality registry data
process_ufs()
Process UF-level data

Validation

vigiar_padronizar_colunas()
Standardise VIGIAR column names
vigiar_validar_ibge()
Validate IBGE municipality codes
vigiar_validar_datas()
Validate date-related columns
vigiar_validar_unidades()
Validate PM2.5 units
vigiar_checar_dados()
Validate downloaded data
vigiar_diagnostico()
Diagnostic summary of all downloaded tables

Diagnostics

vigiar_diagnosticar_serie()
Diagnose a PM2.5 time series
vigiar_checar_cobertura_temporal()
Check temporal coverage
vigiar_checar_cobertura_espacial()
Check spatial coverage
vigiar_checar_pm25()
Check PM2.5 values
vigiar_checar_ibge()
Check IBGE municipality codes
vigiar_checar_duplicatas()
Check for duplicate municipality-time entries
vigiar_checar_quebra_serie()
Detect series breaks
vigiar_classificar_alertas()
Classify overall alert level
vigiar_relatorio_diagnostico()
Generate a diagnostic report

Dictionary

vigiar_dicionario()
Load the VIGIAR variable dictionary
vigiar_variaveis()
List variables for a specific data domain
vigiar_descrever_variavel()
Describe a single VIGIAR variable
vigiar_convencoes()
Open VIGIAR conventions documentation
vigiar_schema()
Show schema for a data domain
vigiar_tabelas_documentadas()
List all documented tables
vigiar_variaveis_nao_documentadas()
Find undocumented variables
vigiar_variaveis_orfas()
Find documented variables that don't exist in the live schema
vigiar_validar_dicionario()
Validate the dictionary against the live schema
vigiar_comparar_schema()
Compare live schema with dictionary

Time Series

vigiar_serie_temporal()
Prepare a VIGIAR tibble for time series exploration
vigiar_tendencia_descritiva()
Compute descriptive temporal trends
vigiar_agregar_tempo()
Aggregate VIGIAR data along the time dimension

Rio de Janeiro

vigiar_rj_municipios()
List all 92 Rio de Janeiro municipalities
vigiar_rj_macrorregioes()
List Rio de Janeiro health macro-regions
vigiar_rj_regioes_saude()
List Rio de Janeiro health regions
vigiar_rj_resumo()
Summarise Rio de Janeiro VIGIAR data
vigiar_rj_series()
Aggregate Rio de Janeiro data by health region
vigiar_validar_rj()
Validate that data contains only RJ municipalities

Audit & Compliance

vigiar_auditar()
Full data compliance audit
vigiar_auditar_tudo()
Audit all downloaded tables
vigiar_compliance_check()
Run a batch audit across multiple compliance profiles
vigiar_checksum()
Compute a deterministic checksum for a data frame
vigiar_exportar_auditoria()
Export audit report as JSON

Benchmark

vigiar_benchmark()
Benchmark VIGIAR download strategies
vigiar_benchmark_tabelas()
Compare download performance across tables
vigiar_health_check()
Run a full health check on the VIGIAR API

Logging

vigiar_log()
Retrieve the complete download log
vigiar_limpar_log()
Clear the operation log
vigiar_exportar_log()
Export the operation log to a file
vigiar_resumo_log()
Summarise the operation log
vigiar_historico_downloads()
Show download history
vigiar_resumo_downloads()
Summary of download history

Snapshots & Cache

vigiar_snapshot()
Snapshot data with full provenance
vigiar_verificar_snapshot()
Verify a snapshot's integrity
vigiar_salvar_snapshot()
Save a snapshot to disk (RDS)
vigiar_carregar_snapshot()
Load a snapshot from disk
vigiar_comparar_snapshots()
Compare two snapshots
vigiar_cache_dir()
Local cache directory for VIGIAR data
vigiar_baixar_com_cache()
Download with local cache
vigiar_cache_info()
List cached tables
vigiar_limpar_cache()
Clear the local cache
vigiar_esquema_lock()
Lock the current schema for reproducibility
vigiar_esquema_carregar_lock()
Load a schema lock
vigiar_esquema_verificar()
Verify schema against a lock

Export

vigiar_exportar_csv()
Export VIGIAR data to CSV
vigiar_exportar_rds()
Export VIGIAR data to RDS
vigiar_exportar_parquet()
Export VIGIAR data to Parquet

Summary

Data

pm25_rj_sample
Sample PM2.5 data for Rio de Janeiro

S3 Classes

print(<vigiar_audit>)
Print method for vigiar_audit
print(<vigiar_audit_list>)
Print method for vigiar_audit_list
print(<vigiar_compliance>)
Print method for vigiar_compliance
print(<vigiar_diagnostic>)
Print a vigiar_diagnostic object
print(<vigiar_snapshot>)
Print method for vigiar_snapshot
print(<vigiar_tbl>)
Print method for vigiar_tbl
summary(<vigiar_diagnostic>)
Summary method for vigiar_diagnostic
summary(<vigiar_tbl>)
Summary method for vigiar_tbl
validate.vigiar_tbl()
Validate a VIGIAR tibble

Utilities

vigiar_lifecycle() stable
Inspect the lifecycle status of exported functions
`%||%`
NULL-coalesce operator