List available datasets

Returns a tibble of datasets in the inspercidados registry.

Usage

list_datasets(
  search = NULL,
  theme = NULL,
  region = NULL,
  project = NULL,
  spatial = NULL,
  include = c("active", "catalogued", "all")
)

Arguments

search: A character string to filter results. Matched case-insensitively against alias, title, description, keywords, theme, and region. Pass NULL (default) to return all datasets.
theme, region, project: Optional filters, matched case-insensitively as regular expressions against the corresponding column.
spatial: Logical. If TRUE, keep only datasets that ship a GeoPackage or GeoJSON. If FALSE, drop them. NULL (default) keeps both.
include: Which registry entries to return. "active" (default) lists datasets you can download. "catalogued" adds entries held in Insper's secure data room, which appear with access = "secure_room" and cannot be downloaded. "all" also includes retired aliases.

Value

A tibble with one row per dataset and columns alias, title, description, theme, region, project, access, is_spatial, formats, keywords, and doi.

Registry updates

The registry is read from the package's GitHub repository once per session, so datasets added after a release appear without reinstalling. When GitHub cannot be reached, or the online registry needs a newer version of the package, the copy shipped with the package is used instead. Set options(inspercidados.registry = "bundled") to always use the shipped copy, for example to keep a script's catalog fixed.

Examples

# List all downloadable datasets
list_datasets()
#> # A tibble: 23 × 11
#>    alias        title description theme region project access is_spatial formats
#>    <chr>        <chr> <chr>       <chr> <chr>  <chr>   <chr>  <lgl>      <chr>  
#>  1 itbi_sp      Impo… "Registros… Habi… São P… itbi    downl… FALSE      csv, p…
#>  2 iptu_sp      IPTU… "Dados do … Habi… São P… densid… downl… TRUE       geojso…
#>  3 alvaras_sp   Alva… "Informaçõ… Habi… São P… alvaras downl… TRUE       geojso…
#>  4 alvaras_sp_… Alva… "Agregação… Habi… São P… alvaras downl… TRUE       geojso…
#>  5 censo_setor… Popu… "Dados pro… Habi… São P… densid… downl… TRUE       geojso…
#>  6 iptu_vertic… Grad… "Dados dem… Habi… São P… densid… downl… TRUE       geojso…
#>  7 densidade_i… Dens… "Cruzament… Habi… São P… densid… downl… TRUE       geojso…
#>  8 geoses_sp    Índi… "Índice so… Mult… São P… geoses  downl… TRUE       geojso…
#>  9 mortalidade… Indi… "Indicador… Saúde São P… mortal… downl… TRUE       geojso…
#> 10 ilhas_calor… Medi… "Estatísti… Clim… Rio d… mare    downl… TRUE       geojso…
#> # ℹ 13 more rows
#> # ℹ 2 more variables: keywords <chr>, doi <chr>

# Search by keyword or theme
list_datasets("metro")
#> # A tibble: 6 × 11
#>   alias         title description theme region project access is_spatial formats
#>   <chr>         <chr> <chr>       <chr> <chr>  <chr>   <chr>  <lgl>      <chr>  
#> 1 embarques_ho… Emba… Embarques … Mobi… Brasil motiva  downl… FALSE      csv, p…
#> 2 embarques_di… Emba… Total de e… Mobi… Brasil motiva  downl… FALSE      parque…
#> 3 embarques_me… Médi… Média de e… Mobi… Brasil motiva  downl… FALSE      rds, t…
#> 4 embarques_in… Emba… Embarques … Mobi… Brasil motiva  downl… FALSE      parque…
#> 5 linhas_motiva Linh… Tabela de … Mobi… Brasil motiva  downl… FALSE      rds, t…
#> 6 estacoes_mot… Linh… Tabela de … Mobi… Brasil motiva  downl… FALSE      rds, t…
#> # ℹ 2 more variables: keywords <chr>, doi <chr>
list_datasets("IPTU")
#> # A tibble: 3 × 11
#>   alias         title description theme region project access is_spatial formats
#>   <chr>         <chr> <chr>       <chr> <chr>  <chr>   <chr>  <lgl>      <chr>  
#> 1 iptu_sp       IPTU… "Dados do … Habi… São P… densid… downl… TRUE       geojso…
#> 2 iptu_vertica… Grad… "Dados dem… Habi… São P… densid… downl… TRUE       geojso…
#> 3 densidade_im… Dens… "Cruzament… Habi… São P… densid… downl… TRUE       geojso…
#> # ℹ 2 more variables: keywords <chr>, doi <chr>

# Only spatial datasets
list_datasets(spatial = TRUE)
#> # A tibble: 13 × 11
#>    alias        title description theme region project access is_spatial formats
#>    <chr>        <chr> <chr>       <chr> <chr>  <chr>   <chr>  <lgl>      <chr>  
#>  1 iptu_sp      IPTU… "Dados do … Habi… São P… densid… downl… TRUE       geojso…
#>  2 alvaras_sp   Alva… "Informaçõ… Habi… São P… alvaras downl… TRUE       geojso…
#>  3 alvaras_sp_… Alva… "Agregação… Habi… São P… alvaras downl… TRUE       geojso…
#>  4 censo_setor… Popu… "Dados pro… Habi… São P… densid… downl… TRUE       geojso…
#>  5 iptu_vertic… Grad… "Dados dem… Habi… São P… densid… downl… TRUE       geojso…
#>  6 densidade_i… Dens… "Cruzament… Habi… São P… densid… downl… TRUE       geojso…
#>  7 geoses_sp    Índi… "Índice so… Mult… São P… geoses  downl… TRUE       geojso…
#>  8 mortalidade… Indi… "Indicador… Saúde São P… mortal… downl… TRUE       geojso…
#>  9 ilhas_calor… Medi… "Estatísti… Clim… Rio d… mare    downl… TRUE       geojso…
#> 10 qualidade_a… Medi… "Estatísti… Clim… Rio d… mare    downl… TRUE       geojso…
#> 11 areas_colet… Medi… "Estatísti… Clim… Rio d… mare    downl… TRUE       geojso…
#> 12 faixa_azul_… Trec… "Localizaç… Mobi… São P… faixa_… downl… TRUE       geojso…
#> 13 sinistros_v… Sini… "Localizaç… Mobi… São P… faixa_… downl… TRUE       geojso…
#> # ℹ 2 more variables: keywords <chr>, doi <chr>

# Datasets from one study
list_datasets(project = "faixa_azul")
#> # A tibble: 3 × 11
#>   alias         title description theme region project access is_spatial formats
#>   <chr>         <chr> <chr>       <chr> <chr>  <chr>   <chr>  <lgl>      <chr>  
#> 1 faixa_azul_sp Trec… Localizaçã… Mobi… São P… faixa_… downl… TRUE       geojso…
#> 2 sinistros_sp  Sini… Sinistros … Mobi… São P… faixa_… downl… FALSE      parque…
#> 3 sinistros_vi… Sini… Localizaçã… Mobi… São P… faixa_… downl… TRUE       geojso…
#> # ℹ 2 more variables: keywords <chr>, doi <chr>

# Include datasets that are catalogued but not downloadable
list_datasets(include = "catalogued")
#> # A tibble: 28 × 11
#>    alias        title description theme region project access is_spatial formats
#>    <chr>        <chr> <chr>       <chr> <chr>  <chr>   <chr>  <lgl>      <chr>  
#>  1 itbi_sp      Impo… "Registros… Habi… São P… itbi    downl… FALSE      csv, p…
#>  2 iptu_sp      IPTU… "Dados do … Habi… São P… densid… downl… TRUE       geojso…
#>  3 alvaras_sp   Alva… "Informaçõ… Habi… São P… alvaras downl… TRUE       geojso…
#>  4 alvaras_sp_… Alva… "Agregação… Habi… São P… alvaras downl… TRUE       geojso…
#>  5 censo_setor… Popu… "Dados pro… Habi… São P… densid… downl… TRUE       geojso…
#>  6 iptu_vertic… Grad… "Dados dem… Habi… São P… densid… downl… TRUE       geojso…
#>  7 densidade_i… Dens… "Cruzament… Habi… São P… densid… downl… TRUE       geojso…
#>  8 geoses_sp    Índi… "Índice so… Mult… São P… geoses  downl… TRUE       geojso…
#>  9 mortalidade… Indi… "Indicador… Saúde São P… mortal… downl… TRUE       geojso…
#> 10 ilhas_calor… Medi… "Estatísti… Clim… Rio d… mare    downl… TRUE       geojso…
#> # ℹ 18 more rows
#> # ℹ 2 more variables: keywords <chr>, doi <chr>

Usage

Arguments

Value

Registry updates

See also

Examples