cnefetools-package: cnefetools: Access and Analysis of Brazilian CNEFE Address...
In cnefetools: Access and Analysis of Brazilian CNEFE Address Data
cnefetools-package R Documentation
cnefetools: Access and Analysis of Brazilian CNEFE Address Data
Description
Download, cache and read municipality-level address data from the Cadastro Nacional de Enderecos para Fins Estatisticos (CNEFE) of the 2022 Brazilian Census, published by the Instituto Brasileiro de Geografia e Estatistica (IBGE) https://ftp.ibge.gov.br/Cadastro_Nacional_de_Enderecos_para_Fins_Estatisticos/. Beyond data access, provides spatial aggregation of addresses, computation of land-use mix indices, and dasymetric interpolation of census tract variables using CNEFE dwelling points as ancillary data. Results can be produced on 'H3' hexagonal grids or user-supplied polygons, and heavy operations leverage a 'DuckDB' backend with extensions for fast, in-process execution.
Package options
cnefetools.duckdb_config takes a named list of DuckDB settings, applied to
every connection the package opens:
options(cnefetools.duckdb_config = list(threads = 4, memory_limit = "4GB"))
Left unset, DuckDB sizes itself against the whole machine, taking one thread
per logical core and a memory_limit of 80% of installed RAM. That is the
right default on a dedicated machine and the wrong one on a shared node, a
laptop running other work, or a CI runner.
Names are passed to DuckDB's SET verbatim, so any setting DuckDB accepts
works, not only these two. An unrecognised name raises an error naming it.
Going over memory_limit makes DuckDB spill to its temporary directory
rather than fail, so a low value costs time, not correctness.
The download cache location is set through the CNEFETOOLS_CACHE_DIR
environment variable rather than an option. See clear_cache_muni() and
clear_cache_tracts().
Author(s)
Maintainer: Jorge Ubirajara Pedreira Junior jorge.ubirajara@ufba.br (ORCID) [copyright holder]
Authors:
Jorge Ubirajara Pedreira Junior jorge.ubirajara@ufba.br (ORCID) [copyright holder]
Bruno Mioto brunomioto97@gmail.com
Other contributors:
Kaio Cunha Pedreira kaiocp7@gmail.com [contributor]
See Also
Useful links:
cnefetools documentation built on Oct. 2, 2026, 1:08 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| cnefetools-package | R Documentation |
cnefetools: Access and Analysis of Brazilian CNEFE Address Data
Description
Download, cache and read municipality-level address data from the Cadastro Nacional de Enderecos para Fins Estatisticos (CNEFE) of the 2022 Brazilian Census, published by the Instituto Brasileiro de Geografia e Estatistica (IBGE) https://ftp.ibge.gov.br/Cadastro_Nacional_de_Enderecos_para_Fins_Estatisticos/. Beyond data access, provides spatial aggregation of addresses, computation of land-use mix indices, and dasymetric interpolation of census tract variables using CNEFE dwelling points as ancillary data. Results can be produced on 'H3' hexagonal grids or user-supplied polygons, and heavy operations leverage a 'DuckDB' backend with extensions for fast, in-process execution.
Package options
cnefetools.duckdb_config takes a named list of DuckDB settings, applied to
every connection the package opens:
options(cnefetools.duckdb_config = list(threads = 4, memory_limit = "4GB"))
Left unset, DuckDB sizes itself against the whole machine, taking one thread
per logical core and a memory_limit of 80% of installed RAM. That is the
right default on a dedicated machine and the wrong one on a shared node, a
laptop running other work, or a CI runner.
Names are passed to DuckDB's SET verbatim, so any setting DuckDB accepts
works, not only these two. An unrecognised name raises an error naming it.
Going over memory_limit makes DuckDB spill to its temporary directory
rather than fail, so a low value costs time, not correctness.
The download cache location is set through the CNEFETOOLS_CACHE_DIR
environment variable rather than an option. See clear_cache_muni() and
clear_cache_tracts().
Author(s)
Maintainer: Jorge Ubirajara Pedreira Junior jorge.ubirajara@ufba.br (ORCID) [copyright holder]
Authors:
Jorge Ubirajara Pedreira Junior jorge.ubirajara@ufba.br (ORCID) [copyright holder]
Bruno Mioto brunomioto97@gmail.com
Other contributors:
Kaio Cunha Pedreira kaiocp7@gmail.com [contributor]
See Also
Useful links:
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.