getRegionais: get list of regionais.

Description Usage Arguments Value Examples

View source: R/utility_tools.R

Description

consult database to get list of regionais

Usage

1
2
3
4
5
6
7
8
getRegionais(
  cities,
  uf,
  sortedby = "a",
  macroreg = FALSE,
  datasource = con,
  output = "names"
)

Arguments

cities

cities' geocodes

uf

full name of the state.

sortedby

the options are: 'a' alphabetically, 'id' regional id number (only valid for regional), if available

macroreg

TRUE if getRegionais should return macroreg instead of reg. Default: False

datasource

name of the database

output

if "names" returns only a vector with names of regionais or macros. If "complete" , returns municipalities and their regs

Value

vector with names of the regionais.

Examples

1
2
3
4
5
6
getRegionais(uf="Rio de Janeiro")
head(getRegionais(uf="Rio de Janeiro",output="complete",macroreg = TRUE))
head(getRegionais(uf="Rio de Janeiro",output="complete"))
getRegionais(cities = c(3304128,3306107,3300159), uf="Rio de Janeiro")
getRegionais(cities = c(3304128,3306107,3300159), uf="Rio de Janeiro", macroreg = TRUE)
getRegionais(uf="Rio de Janeiro", sortedby = 'id')

claudia-codeco/AlertTools documentation built on Aug. 12, 2021, 9:58 a.m.