Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/epiverse-trace/sivirep

Data Wrangling and Automated Reports from 'SIVIGILA' source
https://github.com/epiverse-trace/sivirep

colombia epidemiological-surveillance epiverse public-health r r-package

Last synced: 2 months ago
JSON representation

Data Wrangling and Automated Reports from 'SIVIGILA' source

Awesome Lists containing this project

README

        

---
output: github_document
editor_options:
markdown:
wrap: 72
---

```{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

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)
[![R-CMD-check](https://github.com/epiverse-trace/sivirep/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiverse-trace/sivirep/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/epiverse-trace/sivirep/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiverse-trace/sivirep?branch=main)
[![lifecycle-maturing](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-maturing.svg)](https://www.reconverse.org/lifecycle.html#maturing)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

***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,
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.
Este sistema está regulado por el Instituto Nacional de
Salud 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 los comandos:

```{r list-events-ms, eval = FALSE}
lista_eventos <- list_events()
knitr::kable(lista_eventos)
```

`r paste0("

🦠Listado de enfermedades (haz clic para ver)
")`

```{r list-events-rs, echo = FALSE}
lista_eventos <- NULL
tryCatch({
lista_eventos <- list_events()
knitr::kable(lista_eventos,
col.names = c("Codigo", "Enfermedad", "Año"),
row.names = FALSE, align = "l")
}, error = function(e) {
lista_eventos <- NULL
})
```

`r if (is.null(lista_eventos)) { paste0("

")}`

`r paste0("

")`

## 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 del país, el nombre
del departamento (opcional) y el 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:

> 🎥 [¿Cómo generar un reporte con sivirep?](https://youtu.be/pqzRw5YhP_g)

El reporte que obtendrás al utilizar la plantilla de `sivirep` es este:

> 🎥 [Reporte sivirep](https://youtu.be/1t_Di3fC4hM)

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).