-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
186 lines (138 loc) · 7.42 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
---
output: github_document
editor_options:
markdown:
wrap: 72
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
include = TRUE,
error = FALSE,
warning = FALSE,
message = FALSE
)
```
```{r setup_package, include = FALSE}
library(sivirep)
```
## *sivirep*: Generación automatizada de reportes a partir de bases de datos de vigilancia epidemiológica <img src="man/figures/logo.svg" align="right" width="120"/>
<!-- badges: start -->
[](https://opensource.org/license/mit)
[](https://github.com/epiverse-trace/sivirep/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/epiverse-trace/readepi?branch=main)
[](https://www.reconverse.org/lifecycle.html#maturing)
[](https://www.repostatus.org/#active)
[](https://CRAN.R-project.org/package=sivirep)
<!-- badges: end -->
***sivirep*** es desarrollado por la [Pontificia Universidad
Javeriana](https://www.javeriana.edu.co/inicio) como parte de la iniciativa [Epiverse](https://data.org/initiatives/epiverse/).
La versión actual de *sivirep* 1.0.0 proporciona funciones para la
manipulación de datos y la generación de reportes automatizados basados
en las bases de datos individualizadas de casos de
[SIVIGILA](https://www.ins.gov.co/Direcciones/Vigilancia/Paginas/SIVIGILA.aspx),
que es el sistema oficial de vigilancia epidemiológica de Colombia.
## Exclusión de responsabilidad
El uso de esta librería, así como de los datos, reportes generados y otros productos derivados de la misma, se realiza bajo la responsabilidad exclusiva del usuario. Ni los autores de la librería, ni la Pontificia Universidad Javeriana, ni la fuente de información asumen responsabilidad alguna por los resultados obtenidos o el uso que se haga de dichos productos.
## Motivación
América Latina ha progresado en la calidad de sus sistemas de
notificación y vigilancia epidemiológica. En particular, Colombia ha
mejorado a lo largo de los años la calidad, la accesibilidad y la
transparencia de su sistema oficial de vigilancia epidemiológica,
[SIVIGILA](https://www.ins.gov.co/Direcciones/Vigilancia/Paginas/SIVIGILA.aspx).
Este sistema está regulado por el [Instituto Nacional de
Salud](https://www.ins.gov.co) de Colombia y es operado por miles de
trabajadores de la salud en las secretarías de salud locales, hospitales
y unidades primarias generadoras de datos.
Sin embargo, todavía existen desafíos, especialmente a nivel local, en
cuanto a la oportunidad y la calidad del análisis epidemiológico y de
los informes epidemiológicos. Estas tareas pueden requerir una gran
cantidad de trabajo manual debido a limitaciones en el entrenamiento
para el análisis de datos, el tiempo que se requiere invertir, la
tecnología y la calidad del acceso a internet en algunas regiones de
Colombia.
El objetivo de `sivirep` es proporcionar un conjunto de herramientas
para:
1) Descargar, preprocesar y preparar los datos de SIVIGILA para su
posterior análisis.
2) Generar informes epidemiológicos automatizados adaptables al
contexto.
3) Proporcionar retroalimentación sobre el sistema de vigilancia al
proveedor de la fuente de datos.
## Potenciales usuarios
- Profesionales de salud pública y de epidemiología de campo que
utilizan la fuente de datos de SIVIGILA a nivel local.
- Estudiantes del área de la salud y epidemiología.
- Investigadores y analistas de datos a nivel nacional e
internacional.
## Versiones futuras
Las versiones futuras de `sivirep` podrían incluir:
- Interacción con otras fuentes de datos en Colombia.
- Otros sistemas de vigilancia epidemiológica en América Latina.
## Contribuciones
Las contribuciones son bienvenidas via [pull
requests](https://github.com/epiverse-trace/sivirep/pulls).
Los contribuyentes al paquete incluyen:
**Autores**: [Geraldine Gómez-Millán](https://github.com/GeraldineGomez), [Zulma M. Cucunubá](https://github.com/zmcucunuba), Jennifer A. Mendez-Romero y [Claudia Huguett-Aragón](https://github.com/chuguett)
**Contribuyentes**:
[Hugo Gruson](https://github.com/Bisaloo), [Juanita Romero-Garcés](https://github.com/juanitaromerog), [Jaime A. Pavlich-Mariscal](https://github.com/jpavlich), [Andrés Moreno](https://github.com/andresmore), [Miguel Gámez](https://github.com/megamezl), [Laura Gómez-Bermeo](https://github.com/lgbermeo), Johan Calderón, Lady Flórez-Tapiero, Verónica Tangarife-Arredondo y Gerard Alarcon
## Código de conducta
Por favor, ten en cuenta que el proyecto `sivirep` se publica con un
[Código de Conducta para
Contribuyentes](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
Al contribuir a este proyecto, aceptas cumplir con sus términos.
## Instalación
Puedes instalar `sivirep` desde CRAN utilizando:
```{r}
install.packages("sivirep")
```
Si deseas instalar la versión de desarrollo de `sivirep` desde GitHub puedes hacerlos con
el siguiente comando:
```{r inst-sivirep, eval = FALSE}
install.packages("pak")
pak::pak("epiverse-trace/sivirep")
```
También, puedes utilizar cualquiera de estas dos opciones:
```{r isnt-opt-r, eval = FALSE}
install.packages("remotes")
remotes::install_github("epiverse-trace/sivirep")
```
```{r inst-opt, eval = FALSE}
install.packages("sivirep", repos = c("https://epiverse-trace.r-universe.dev", "https://cloud.r-project.org"))
```
## Inicio rápido
Puedes iniciar importando el paquete después de finalizada su
instalación con el siguiente comando:
```{r import-sivirep, eval = FALSE}
library(sivirep)
```
Puedes revisar las enfermedades y los años disponibles para su descarga
de forma libre utilizando:
```{r list-events}
lista_eventos <- list_events()
knitr::kable(lista_eventos)
```
## Reporte automatizado
Actualmente, `sivirep` provee una plantilla de reporte llamada
`Reporte Básico {sivirep}`, la cual recibe los siguientes parámetros de
entrada: el nombre de la enfermedad, el año, el nombre de departamento
(opcional) y nombre del municipio (opcional) para descargar los datos de
la fuente de SIVIGILA.
Para hacer uso de la plantilla del reporte puedes seguir los
siguientes pasos:
```{=html}
<video controls autoplay width="100%" loop>
<source src="https://github.com/epiverse-trace/sivirep/assets/10783929/acbb0111-4044-4698-8e0c-f8e902ddaba3" type="video/webm" label="fullHD">
</video>
```
El reporte que obtendrás al utilizar la plantilla de `sivirep` es este:
```{=html}
<video controls autoplay width="100%" loop>
<source src="https://github.com/epiverse-trace/sivirep/assets/10783929/265f9bd5-8da5-45b7-b216-3d7648328037" type="video/webm" label="fullHD">
</video>
```
Si deseas generar el reporte en formato PDF debes instalar LateX. Puedes instalarlo siguiendo las instrucciones que se
encuentran en [R Markdown Cookbook](https://bookdown.org/yihui/rmarkdown-cookbook/install-latex.html).