From ea4fc37f8adc4f7ef040764a6387fd8f2190bdf3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlio=20Hoffimann?= Date: Tue, 10 Oct 2023 09:02:14 -0300 Subject: [PATCH] Update README --- README.md | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index bef4b8c..c50708f 100644 --- a/README.md +++ b/README.md @@ -5,39 +5,22 @@ Julia package for loading geospatial artifacts, e.g. datasets, from different databases. -# Usage +## Datasets -### (Down)loading data from GADM - -The `GADM.get` function (down)loads data from the GADM dataset: +### GADM ```julia julia> GADM.get("BRA", depth = 1) ``` -### (Down)loading data from INMET +### INMET ```julia julia> INMET.stations() -565×13 GeoTable over 565 PointSet{3,Float64} -┌────────────┬────────────┬───────────┬─────────────┬─────────────┬────────────────┬─────────────────┬─────────────────────────── -│ TP_ESTACAO │ CD_ESTACAO │ SG_ESTADO │ CD_SITUACAO │ CD_DISTRITO │ CD_OSCAR │ DT_FIM_OPERACAO │ CD_WSI ⋯ -│ Textual │ Textual │ Textual │ Textual │ Textual │ Textual │ Missing │ Textual ⋯ -│ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] │ [NoUnits] ⋯ -├────────────┼────────────┼───────────┼─────────────┼─────────────┼────────────────┼─────────────────┼─────────────────────────── -│ Automatica │ A422 │ BA │ Pane │ 04 │ 0-2000-0-86765 │ missing │ 0-76-0-2906907000000408 ⋯ -│ Automatica │ A360 │ CE │ Operante │ 03 │ 0-2000-0-81755 │ missing │ 0-76-0-2300200000000446 ⋯ -│ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ │ ⋮ ⋱ -└────────────┴────────────┴───────────┴─────────────┴─────────────┴────────────────┴─────────────────┴─────────────────────────── - 5 columns and 563 rows omitted ``` -### Loading data from GeoStatsImages.jl +### GeoStatsImages.jl ```julia julia> GeoStatsImages.geostatsimage(identifier) ``` - -where `identifier` can be any of the strings listed with the command `GeoStatsImages.available()`. - -Please read the docstrings for more details.