Guided help at the console

Prints a short, copy-pasteable guide for common tasks: getting started, understanding the catalogue, listing layers, downloading data, rendering WMS maps and tuning options. It complements ?argentum (the grouped reference) and the vignettes (the long-form articles).

Usage

argentum_help(topic = "inicio", lang = c("es", "en"))

Arguments

topic

What to explain. One of "inicio" (default), "catalogo", "capas", "descargar", "wms" or "opciones". English synonyms ("start", "catalog", "layers", "download", "options") are accepted.

lang

"es" (default) or "en".

Value

topic, invisibly. Called for its printed output.

Examples

argentum_help()
#> 
#> ── argentum: datos geoespaciales públicos argentinos ───────────────────────────
#> El flujo típico son tres pasos: encontrar el organismo, ver sus capas, traer
#> una.
#> library(Argentum)
#> orgs <- argentum_organizations()             # 1. ¿quién publica?
#> argentum_search_organizations("catastro")    #    ...o buscalo
#> ign <- "https://wms.ign.gob.ar/geoserver/ows"
#> argentum_layers(ign)                         # 2. ¿qué capas tiene?
#> prov <- argentum_read_wfs(ign, "ign:provincia")  # 3. traela como sf
#> plot(sf::st_geometry(prov))
#> Si preferís elegir con menús, todo eso junto es `argentum_browse()`.
#> 
#> ── Más ayuda ──
#> 
#> • `argentum_help("catalogo")` - qué es el catálogo y de dónde sale
#> • `argentum_help("capas")` - listar capas y leer sus columnas
#> • `argentum_help("descargar")` - bajar capas a disco
#> • `argentum_help("wms")` - mapas ya dibujados por el servidor
#> • `argentum_help("opciones")` - timeouts, caché, reintentos
#> • `?argentum` - la referencia completa, agrupada por tarea
argentum_help("descargar")
#> 
#> ── Bajar capas a disco ─────────────────────────────────────────────────────────
#> Para una capa puntual, leela y escribila vos:
#> prov <- argentum_read_wfs(url, "ign:provincia")
#> sf::st_write(prov, "provincias.gpkg")
#> Para varias capas (o todas), `argentum_download()` hace el recorrido y no
#> aborta si una falla:
#> reporte <- argentum_download(url, dir = "datos/ign", format = "gpkg")
#> subset(reporte, status == "error")   # qué falló y por qué
#> • Formatos: "gpkg" (recomendado), "geojson", "shp".
#> • Filtrá antes de bajar: `argentum_read_wfs(url, capa, bbox = c(...), filter =
#>   "provincia = 'Mendoza'")` — el filtro corre en el servidor.
#> • Con menús: `argentum_browse(action = "download")`.
argentum_help("download", lang = "en")
#> 
#> ── Writing layers to disk ──────────────────────────────────────────────────────
#> For one layer, read it and write it yourself:
#> prov <- argentum_read_wfs(url, "ign:provincia")
#> sf::st_write(prov, "provinces.gpkg")
#> For several (or all), `argentum_download()` walks the service and does not
#> abort on one failure:
#> report <- argentum_download(url, dir = "data/ign", format = "gpkg")
#> subset(report, status == "error")   # what failed, and why
#> • Formats: "gpkg" (recommended), "geojson", "shp".
#> • Filter before downloading: `argentum_read_wfs(url, layer, bbox = c(...),
#>   filter = "...")` runs server-side.
#> • With menus: `argentum_browse(action = "download")`.