forked from fmgarciadiaz/PortalHacienda-CRAN
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
110 lines (79 loc) · 3.95 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
---
output: github_document
always_allow_html: true
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "80%"
)
```
<!-- badges: start -->
[](https://cran.r-project.org/package=PortalHacienda)
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://github.com/fmgarciadiaz/PortalHacienda-CRAN/actions)
[](https://doi.org/10.5281/zenodo.3893947)
[](https://cran.r-project.org/package=PortalHacienda)
<!-- badges: end -->
# PortalHacienda <img src='man/figures/logo.png' align="right" height="138.5" />
Un paquete de interfase a la API del Portal de Datos del Ministerio de Hacienda
- **Buscar** series en la descripción de los meta-datos
- **Descargar** las series directamente de la API del Portal
- **Extender y proyectar** rápidamente series descargadas (funcionalidad muy básica)
## Instalación
Para instalar el paquete desde [CRAN](https://CRAN.R-project.org) con:
```{r gh-installation, eval = FALSE}
install.packages("PortalHacienda")
```
Instalar versión de desarrollo:
```{r gh-installation2, eval = FALSE}
# install.packages("devtools")
devtools::install_github("fmgarciadiaz/PortalHacienda-CRAN")
```
**Nota**: Debe instalarse previamente el paquete `devtools` para permitir la descarga desde `github`.
## Ejemplo
Búsqueda de series en la base de meta-datos online con `Search_online`.
```{r example}
# Cargar el paquete
library(PortalHacienda)
# Buscar series relacionadas con el tipo de cambio
Series_TCN <- Search_online("tipo de cambio")
# Borrar la columna de links que devuelve la búsqueda y un par más
Series_TCN$distribucion_url_descarga <- NULL
Series_TCN$dataset_id <- NULL
Series_TCN$dataset_descripcion <- NULL
# mostrar prieras tres líneas de la tabla
kableExtra::kable_styling(knitr::kable(head(Series_TCN,3) ,"html"),
font_size = 6,
bootstrap_options = c("striped", "hover", "condensed", "responsive"),fixed_thead = T)
```
Bajar serie de tipo de cambio con `Get` y extender 12 períodos con `Forecast` (usa modelo auto-detectado del paquete ***forecast*** y extiende según la frecuencia detectada, días, meses o años).
Luego hacer un plot sencillo.
```{r example2}
TCN <- Forecast(Get("174.1_T_DE_CATES_0_0_32" , start_date = 2000), 12)
# Mostrar resultado
plot(TCN , main = "Tipo de Cambio Nominal ($/USD)")
```
También se pueden obtener varias series al mismo tiempo, separando con comas...
```{r example3}
plot(Get("6.2_AGCS_2004_T_39,6.2_IM_2004_T_23,6.2_C_2004_T_12") , legend.loc = "topleft" , main = "VAB sectorial ($ de 2004)")
```
En caso de cargar varias series y desear proyecciones automáticas, utilizar la
variante vectorial de `Forecast`, que es `vForecast`:
```{r example4}
TCN <- vForecast(Get("120.1_PCE_1993_0_24,120.1_ED1_1993_0_26"),12)
```
### Nota:
Las series se cargan en formato XTS, con la periodicidad auto-detectada por el paquete `xts`.
La periocidiad es usada por la función `Forecast` para correcta detección de *estacionalidad* y *lags*. `Forecast` agrega demás intervalos de confianza del 95%.
## Cómo citar
> Fernando García Díaz. (2020, June 14). fmgarciadiaz/PortalHacienda-CRAN. https://doi.org/10.5281/zenodo.3893947
## Estado del Proyecto
- [x] Aprobado en CRAN!
- [x] Funcionalidad *básica*
- [x] Captura de errores - conexión de internet, errores devueltos por la API, etc.
- [x] Mejorar la documentación
- [ ] Mejora de la función Search_online (i.e. evitar una descarga por búsqueda)