Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
juliohm committed Oct 10, 2023
1 parent 4deb2d6 commit ea4fc37
Showing 1 changed file with 4 additions and 21 deletions.
25 changes: 4 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 │ 040-2000-0-86765missing0-76-0-2906907000000408
│ Automatica │ A360 │ CE │ Operante │ 030-2000-0-81755missing0-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.

2 comments on commit ea4fc37

@eliascarv
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/93107

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" ea4fc37f8adc4f7ef040764a6387fd8f2190bdf3
git push origin v0.1.0

Please sign in to comment.