get_asentamientos {geoAr}

Obtener Asentamientos de BAHRA

Description

Permite realizar búsquedas sobre el listado de asentamientos BAHRA. Realiza la consulta GET al endpoint /asentamientos de georef-ar-api. Si existe GEOREFAR_TOKEN en el Renviron lo usará para hacer la consulta.

Usage

get_asentamientos(
  id = NULL,
  nombre = NULL,
  provincia = NULL,
  departamento = NULL,
  municipio = NULL,
  localidad_censal = NULL,
  orden = NULL,
  aplanar = TRUE,
  campos = NULL,
  max = NULL,
  exacto = NULL
)

Arguments

id

text Filtrar por ID.

nombre

text Filtrar por Nombre.

provincia

text Filtrar por nombre o ID de Provincia.

departamento

text Filtrar por nombre o ID de Departamento.

municipio

text Filtrar por nombre o ID de Municipio.

localidad_censal

text Filtrar por nombre o ID de localidad censal. Se pueden especificar varios IDs separados por comas

orden

text Campo por el cual ordenar los resultados (por ID o nombre)

aplanar

boolean Cuando está presente, muestra el resultado JSON con una estructura plana.

campos

text Campos a incluir en la respuesta separados por comas, sin espacios. Algunos campos siempre serán incluidos, incluso si no se agregaron en la lista. Para incluir campos de sub-entidades, separar los nombres con un punto, por ejemplo: provincia.id.

max

integer Cantidad máxima de resultados a devolver.

exacto

boolean Cuando está presente, se activa el modo de búsqueda por texto exacto. Sólo tiene efecto cuando se usan campos de búsqueda por texto (por ejemplo, nombre).

Value

Un Data Frame con el listado de Asentamientos BAHRA.

References

georef-ar-api/asentamientos

Examples

## Not run: 
get_asentamientos()

## End(Not run)