-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
137 lines (94 loc) · 5.66 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# **rgeomex**
[![Build Status](https://travis-ci.com/fdzul/rgeomex.svg?branch=main)](https://travis-ci.com/fdzul/rgeomex)
[![HitCount](https://hits.dwyl.com/fdzul/fdzul/rgeomex.svg?style=flat-square)](http://hits.dwyl.com/fdzul/fdzul/rgeomex)
![GitHub all releases](https://img.shields.io/github/downloads/fdzul/rgeomex/total)
[![Codecov test coverage](https://codecov.io/gh/fdzul/rgeomex/branch/master/graph/badge.svg)](https://codecov.io/gh/fdzul/rgeomex?branch=master)
<img align="center" src="man/figures/logo.png" alt="logo" width="140">
**rgeomex** is a package developed in the [CENAPRECE](https://www.gob.mx/salud/cenaprece) dengue prevention and control program in collaboration with [INDRE](https://www.gob.mx/salud/acciones-y-programas/instituto-de-diagnostico-y-referencia-epidemiologicos-mision-vision-y-politica-de-calidad-181639?state=published), & the Yucatan state.
## **overview**
Geographical datasets from the [INEGI](https://www.inegi.org.mx/temas/mg) and [INE](https://pautas.ine.mx/transparencia/mapas/) are available in the R package **rgeomex**. Geographical dataset at various resolutions (states, municipalities, localities, agebs, blocks, sectors, and neighborhoods) constitute the majority of the package's content.
**rgeomex** constitutes a transversal package of the **ETVerse** and **IVAverse** initiatives. [rgeomex](https://fdzul.github.io/rgeomex/), together with *denepikit*, *denhotspots*, [deneggs](https://fdzul.github.io/deneggs/), and *dencontrol* packages, constitute a universe of packages that make up the dengueverse of the dengue prevention and control program in Mexico.
The package has six spatial datasets and functions for extract the AGEBs (extract_ageb), blocks (extract_blocks), sectores (extract_sectores) & localities (extract_locality).
- **`AGEB_inegi_2019_mx`** spatial dataset containing polygon data of AGEBs (Area Geostadística Basica) from Mexico (INEGI 2019). The urban AGEBs are split in two files.
```{r agebs, echo=FALSE, dpi = 300}
tibble::tibble(dataset = c("rgeomex::AGEB_inegi_2019_a",
"rgeomex::AGEB_inegi_2019_b"),
id_states = c("01-16", "17-32")) |>
gt::gt()
```
- **`blocks_ine20_mx`** spatial dataset containing polygon data of blocks from Mexico (INE 2020). The blocks of the urban cities are split in five files from a to e.
```{r blocks, echo=FALSE, dpi = 300}
tibble::tibble(dataset = c("blocks_ine20_mx_a",
"blocks_ine20_mx_b",
"blocks_ine20_mx_c",
"blocks_ine20_mx_d",
"blocks_ine20_mx_e"),
id_states = c("1-10", "11-14",
"15-19", "20-25",
"26-32")) |>
gt::gt()
```
- **`sectores_ine20_mx`** spatial dataset containing polygon data sectores INE from Mexico.
```{r sectores, echo=FALSE, dpi = 300}
tibble::tibble(dataset = c("sectores_ine20_mx_a",
"sectores_ine20_mx_b",
"sectores_ine20_mx_c"),
id_states = c("01-10", "11-20", "21-32")) |>
gt::gt()
```
- **`loc_inegi19_mx`** spatial dataset containing polygon data of localities from Mexico (INEGI 2019).
- **`AGEE_inegi19_mx`** spatial dataset containing polygon data of AGEE (Area Geostadística Estatal) from Mexico (INEGI 2019).
- **`AGEM_inegi19_mx`** spatial dataset containing polygon data of AGEM (Area Geostadística Municipal) from Mexico (INEGI 2019).
This package is currently available only in R, and we hope that it will soon become available in Python.
## Installation R
You can install the released version of rgeomex from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("rgeomex")
```
And the development version from [GitHub](https://github.com/) with:
``` r
devtools::install_github("fdzul/rgeomex")
```
or
``` r
pak::pkg_install("fdzul/rgeomex")
```
## Authors
* **Felipe Antonio Dzul Manzanilla** -**https://github.com/fdzul** - Packages developed in github:
1) [denhotspots](https://github.com/fdzul/denhotspots).
2) [boldenr](https://github.com/fdzul/boldenr).
3) [dendata](https://github.com/fdzul/dendata).
4) [deneggs](https://github.com/fdzul/deneggs).
* **Fabián Correa Morales**
* **Luis Hernández Herrera**
* **Arturo Baez**
* **Evaristo Morales Ríos**
* **Heron Huerta**
* **Dorothy Dzul-Cuevas**
See also the list of [contributors](https://github.com/fdzul/geomex/contributors) who participated in this project.
## Credits
Original shapefiles are created by official government institutions ([INEGI](https://www.inegi.org.mx/temas/mg) & [INE](https://pautas.ine.mx/transparencia/mapas/)).
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Inspiration
The package was inspired by the need to contribute toward making decisions in the dengue prevention and control program, specifically through the identification of dengue vector hotspots and use the entomological information generated by the program.
## Getting help
If you encounter a clear bug, please file a minimal reproducible example
on [github](https://github.com/fdzul/rgeomex/issues). For questions
and other discussion, feel free to contact me ([email protected])
-----
Please note that this project is released with a [Contributor Code of
Conduct](https://dplyr.tidyverse.org/CODE_OF_CONDUCT). By participating
in this project you agree to abide by its terms.