-
Notifications
You must be signed in to change notification settings - Fork 8
/
README.Rmd
139 lines (104 loc) · 4.08 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
138
139
---
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%"
)
```
# junr
<!-- badges: start -->
[](https://travis-ci.org/FvD/junr)
[](https://codecov.io/github/FvD/junr?branch=master)
[](https://cran.r-project.org/package=junr)
<!-- badges: end -->
## Access Open Data in R through the Junar API
The Junar API is the basis for a number of Open Data initiatives in Latin
America and the USA. The `junr` package is a wrapper to make it easier to
access data made public through the Junar API. Some examples of implementations
are: [the City of Pasadena](http://data.cityofpasadena.net/home/), and [the
City of San Jose](http://data.sanjoseca.gov/home/). Others are listed on the
[Junar website](http://junar.com/).
### Installation
```{r, eval=FALSE}
install.packages("devtools")
devtools::install_github("FvD/junr")
```
### Usage
For a full example, please consult the [package
vignette](http://rpubs.com/FvD/access-junar-api).
**Load the package and set URL and API-Key**
```{r}
library(junr)
base_url <- "http://api.datosabiertos.presidencia.go.cr/api/v2/datastreams/"
api_key <- "the-API-Key-from-the-corresponding-url"
```
With this connection information the `junr` package helps you to do the following:
**Get the index of data behind the base URL**
```{r, eval=FALSE}
get_index(base_url, api_key)
```
You can also just get a list of GUID's `list_guid(base_url, api_key)` or a list
of data set titles `list_titles(base_url, api_key)`.
**Get a particular data set**
```{r, eval=FALSE}
data_guid <- "COMPR-PUBLI-DEL-MINIS"
purchasing_data <- get_data(base_url, api_key, data_guid)
```
**Determine data dimensions**
```{r, eval=FALSE}
get_dimensions(base_url, api_key)
```
**Clean up currency data**
```{r, eval=FALSE}
currency_data <- get_data(base_url, api_key, "LICIT-ADJUD-POR-LOS-MINIS")
currency_data$`Monto Adjudicado` <- clean_currency(currency_data$`Monto Adjudicado`)
```
## Accede Datos a través del API de Junar en R
El API de Junar es la base para varias iniciativas de Datos Abiertos en Latino
América y los EEUU. El paquete `junr` facilita el acceso a estos datos des R.
El objetivo es fomentar el uso de los datos disponibles haciendo el acceso lo
mas fácil. Algunos ejemplos de implementaciones son: [el Portal de Datos
Abiertos del Gobierno de Costa
Rica](http://datosabiertos.presidencia.go.cr/home) y la Ciudad de Córdoba (Argentina)
entre otros. Otros se pueden encontrar en el [sitio web de Junar](http://junar.com/).
### Instalación
Para instalar este paquete desde Github es necesario tener el paquete
`devtools` instalado:
```{r, eval=FALSE}
install.packages("devtools")
devtools::install_github("FvD/junr")
```
### Uso
Para un ejemplo completo por favor consulta la [documentación](http://rpubs.com/FvD/acceder-junar-api).
**Carga el paquete y define el URL y API-Key**
```{r, eval=FALSE}
library(junr)
url_base <- "http://api.datosabiertos.presidencia.go.cr/api/v2/datastreams/"
api_key <- "El-API-Key-que-obtuviste-de-la-pagina"
```
**Obten un indice de los datos detras del URL**
```{r, eval=FALSE}
get_index(url_base, api_key)
```
Para tener solo una lista de los GUID la instrucción puedes usar
`list_guid(url_base, api_key)` o para solo un listado de los títulos:
`list_titles(url_base, api_key)`
**Obten un conjunto de datos determinado**
```{r, eval=FALSE}
guid_datos <- "COMPR-PUBLI-DEL-MINIS"
datos_compras <- get_data(url_base, api_key, guid_datos)
```
**Determina la cantidad de datos disponibles**
```{r, eval=FALSE}
get_dimensions(url_base, api_key)
```
**Limpiar valores de divisas**
```{r, eval=FALSE}
datos_con_divisas <- get_data(base_url, api_key, "LICIT-ADJUD-POR-LOS-MINIS")
datos_con_divisas$`Monto Adjudicado` <- clean_currency(datos_con_divisas$`Monto Adjudicado`)
```