Awesome

geouy <img align="right" src="man/figures/geouy_logo_a.png" alt="logo" width="160"> <img align="right" src="man/figures/geouy_logo_b.png" alt="logo" width="160">

geouy is an R package that allows users to easily access official spatial data sets of Uruguay. The package includes a wide range of geospatial datasets as simple features (sf), available at various geographic scales and for various years with harmonized attributes and projection (see detailed list below).

Installation

# From CRAN
  install.packages("geouy")
  library(geouy)
  
# Use the development version with latest features
  utils::remove.packages('geouy')
  devtools::install_github("RichDeto/geouy")
  library(geouy)

obs. If you use Linux, you need to install a couple dependencies before installing the libraries sf and geouy. More info here.

Basic Usage

load_geouy

The syntax of all geouy functions operate one the same logic so it becomes intuitive to download any data set using a single line of code. Like this:

secc <- load_geouy("Secciones")

Available datasets:

Administrative limits

Demography

Hidrology

Ways

Services

Orthophotos

Land Cover

which_uy()

Add to an sf object its spatial coincidence with one or more administrative units in Uruguay, generating the corresponding variables.

where_uy()

You get an sf object of one or more administrative units in Uruguay, according to a query by code or name in the layer.

add_geom()

This function allows you to add a geom variable with a code variable of "zona", "barrio", "localidad", "segmentos", "secciones" or "departamentos".

geocode_ide_uy()

Allows geocoding directions using IDE_uy.

plot_geouy()

Plot a variable of your sf object with north and scale, set on a simple theme.

Other functions:

is.uy4326(): Test if an sf object match with Uruguay at crs = 4326. is.uy32721(): Test if an sf object match with Uruguay at crs = 32721. is.uy5381(): Test if an sf object match with Uruguay at crs = 5381. is.uy5382(): Test if an sf object match with Uruguay at crs = 5382.

Datasets

metadata

This dataset has the metadata of all vector geometries provided by geouy and detailed at the top

metadata_wms

This dataset has the metadata of all the raster services that will be provided by geouy, although the functions are still under development.

loc_agr_ine

This dataset allows you to aggregate Localidades INE by the aglomerations used by INE. An example of use can be:

loc <- which_uy(base, "Localidades pg") %>% 
    dplyr::left_join(loc_agr_ine, by = c("cod_Localidades pg" = "codloc"))

uy_deptos_grid and mvd_barrios_grid

Two datasets to use as geofacet grid dataset for departments of Uruguay and neighborhoods of Montevideo.

History

This package arises from the conjugation of own ideas with an eye on the region. It started as a part of the package where I work with @calcita at ech, and some geospatial service packages in the region mainly: geobr and chilemapas

This walk on the shoulders of giants, allows this package focused on this small country (my beautiful Uruguay), to have its own particularities although it tries to fit especially to geobr in its structure and with a view to complementing ech.

Community contributions es

This package intends to incorporate any function of general requirements that use the geographic data of Uruguay as a base. All contributions in this regard are welcome.

If you work with geographic data of Uruguay and want to add your function or data, we recommend that you read the following tips on how to collaborate:

To add your function:

- Fork of this repository
- Add your function as an `.R` file in the `R/` folder with the same name as the function
- Document it with `roxygen2` clarifying its functionality, parameters and an example of use. To see how it is documented to review another function in the same directory
- Remember at the end of the documentation you must add a # '@export
- Check that the types and values of your function parameters are fine (for example, you can look at `data-raw/metadata.R`
- Add the dependencies in the `DESCRIPTION` file 
- Check the package with devtools::check()
- If everything works fine, then make a pull request

To add geographic data to the load_geouy() function:

- Fork of this repository
- Identify the corresponding WFS service URL
- Add a record to the `metadata` file in the `data-raw/` directory, with the corresponding data.
- Also include this record in the corresponding table of the `README.md` file, with the corresponding format.
- If everything works fine, then make a pull request

<i class="fa fa-pencil" aria-hidden="true"></i> Citation

To cite geouy in publications, please use:

Detomasi, Richard (2021) "geouy: Geographic Information of Uruguay". R package version 0.2.5 URL: https://github.com/RichDeto/geouy.

A BibTeX entry for LaTeX users is:

@Misc{geouy,
  title = {geouy: Geographic Information of Uruguay},
  author = {Richard Detomasi},
  note = {R package version 0.2.5},
  year = {2021},
  url  = {https://github.com/RichDeto/geouy},
}