geoAr (version 1.0.0)

get_provincias: Obtener Provincias

Description

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

Usage

get_provincias(
  id = NULL,
  nombre = NULL,
  orden = NULL,
  aplanar = TRUE,
  campos = NULL,
  max = NULL,
  exacto = NULL
)

Value

Un Data Frame con el listado de Provincias

Arguments

id

text Filtrar por ID.

nombre

text Filtrar por Nombre.

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).

References

georef-ar-api/provincias

Examples

if (FALSE) {
get_provincias(nombre = "Cordoba")
}