-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: create Inicio rápido vignette
Ref: #133
- Loading branch information
1 parent
10927ef
commit 22fb011
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
title: "Inicio rápido" | ||
output: rmarkdown::html_vignette | ||
vignette: > | ||
%\VignetteIndexEntry{Análisis o reportes personalizados} | ||
%\VignetteEngine{knitr::rmarkdown} | ||
%\VignetteEncoding{UTF-8} | ||
--- | ||
|
||
|
||
# Inicio rápido | ||
|
||
Puedes instalar la versión de desarrollo de `sivirep` desde GitHub con | ||
el siguiente comando: | ||
|
||
```{r setup_sivirep, eval = FALSE} | ||
install.packages("pak") | ||
pak::pak("epiverse-trace/sivirep") | ||
``` | ||
|
||
Después de la instalación de `sivirep`, puedes comenzar importando el | ||
paquete a través del siguiente comando: | ||
|
||
```{r import_sivirep} | ||
library(sivirep) | ||
``` | ||
|
||
## Enfermedades disponibles para su descarga | ||
|
||
Puedes revisar las enfermedades y los años disponibles de forma libre | ||
utilizando: | ||
|
||
```{r list_events} | ||
lista_eventos <- list_events() | ||
knitr::kable(lista_eventos) | ||
``` | ||
|
||
## Reporte automatizado | ||
|
||
## 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: | ||
|
||
<img src="man/figures/template.gif" width="900" height="500"/> | ||
|
||
El reporte que obtendrás al utilizar la plantilla de `sivirep` es este: | ||
|
||
<img src="man/figures/template-report.gif" width="600" height="800"/> | ||
|
||
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): | ||
|
||
Para obtener más detalles sobre plantillas y reportes genéricos de R | ||
Markdown, por favor consulta [R Markdown templates](https://rstudio.github.io/rstudio-extensions/rmarkdown_templates.html). |