Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix review items #214

Merged
merged 39 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
78517ea
chore: improve package's description
GeraldineGomez Nov 12, 2024
1b90896
feat(obtener_ruta_dir): add cache parameter
GeraldineGomez Nov 13, 2024
1fab175
feat: add ruta_dir parameter and use tempdir() in examples
GeraldineGomez Nov 13, 2024
0f899aa
chore: wrap examples with donttest
GeraldineGomez Nov 13, 2024
9462e08
chore: replace dontrun with dontest in examples
GeraldineGomez Nov 13, 2024
9ec3855
chore: use ruta_dir = tempdir() and cache paramer in examples
GeraldineGomez Nov 13, 2024
92da1b1
chore: set cache = FALSE
GeraldineGomez Nov 13, 2024
071e2bd
chore(plot_fecha_ini): wrap example with donttest
GeraldineGomez Nov 13, 2024
88bdc89
chore(plot): use ruta_dir = tempdir() and cache param in examples
GeraldineGomez Nov 13, 2024
63ddc02
chore(plot_year): replace dontrun with donttest in examples
GeraldineGomez Nov 13, 2024
ecf71cc
chore: add ruta_dir parameter to invoke import_pob_incidencia
GeraldineGomez Nov 13, 2024
2f91cb3
test: use ruta_dir = tempdir() to invoke import function
GeraldineGomez Nov 13, 2024
fe96282
chore(custom_analysis): add cache parameter
GeraldineGomez Nov 13, 2024
69b0c68
chore(custom_analysis): add cache parameter
GeraldineGomez Nov 13, 2024
1b75479
feat(incidence): add cache and ruta_dir parameter
GeraldineGomez Nov 13, 2024
f9ad459
chore(skeleton): add cache input
GeraldineGomez Nov 13, 2024
b089d72
chore(skeleton): add logic for ruta_dir and cache params
GeraldineGomez Nov 13, 2024
087096d
feat(incidencia_geo): send ruta_dir and cache params
GeraldineGomez Nov 13, 2024
bd84938
fix(skeleton): logic of ruta_dir and cache
GeraldineGomez Nov 13, 2024
b969219
chore: add new CRAN comments
GeraldineGomez Nov 18, 2024
4db8899
chore(README): add CRAN badge
GeraldineGomez Nov 18, 2024
7c396fd
Automatic readme update
actions-user Nov 18, 2024
8bf8c94
fix: replace es_ES with es-ES
GeraldineGomez Nov 22, 2024
bcba50b
chore: replaced cache examples with ruta_dir = tempdir()
GeraldineGomez Nov 22, 2024
1c58f58
chore: update cran-comments
GeraldineGomez Nov 22, 2024
b405525
Merge branch 'fix-review-items' of github.com:epiverse-trace/sivirep …
GeraldineGomez Nov 22, 2024
d010080
Merge remote-tracking branch 'origin/main' into fix-review-items
GeraldineGomez Nov 22, 2024
18ce32f
chore(calcular_incidencia): add interactive for cache param
GeraldineGomez Nov 22, 2024
171f8d8
chore(calcular_incidencia_geo): add interactive for cache param
GeraldineGomez Nov 22, 2024
1615ef7
chore(calcular_incidencia_sex): add interactive for cache param
GeraldineGomez Nov 22, 2024
6091a60
fix: remove spaces and restore original examples
GeraldineGomez Nov 22, 2024
4b9756c
chore(import_pob_incidencia): add interactive for cache param
GeraldineGomez Nov 22, 2024
7b0362f
chore(import_pob_proyecciones): add interactive for cache param
GeraldineGomez Nov 22, 2024
8b3f4dd
chore(import_pob_riesgo): add interactive for cache param
GeraldineGomez Nov 22, 2024
5d1acd7
chore(plot_map): add interactive for cache param
GeraldineGomez Nov 22, 2024
9b331ea
chore: update cran-comments
GeraldineGomez Nov 22, 2024
eca58bd
Increment version number to 1.0.1
GeraldineGomez Nov 22, 2024
2c77300
chore: add patch version
GeraldineGomez Nov 22, 2024
3fd58ae
chore: update cran-comments
GeraldineGomez Nov 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: sivirep
Title: Data Wrangling and Automated Reports from 'SIVIGILA' Source
Type: Package
Version: 1.0.0
Version: 1.0.1
Authors@R:
c(
person(given = "Geraldine", family = "Gómez-Millán", email = "[email protected]", role = c("aut", "cre", "ctb"),
Expand Down Expand Up @@ -67,7 +67,7 @@ Config/Needs/website:
r-lib/pkgdown,
epiverse-trace/epiversetheme
VignetteBuilder: knitr
Language: es_ES
Language: es-ES
URL: https://epiverse-trace.github.io/sivirep/, https://github.com/epiverse-trace/sivirep
BugReports: https://github.com/epiverse-trace/sivirep/issues
Config/testthat/edition: 3
12 changes: 12 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# sivirep 1.0.1

# sivirep 0.0.1

This is the initial version of the package. It contains four modules which are as follows:
Expand Down Expand Up @@ -78,3 +80,13 @@ The report template `Reporte Basico` now includes five new sections called:
- `Distribución por área geográfica`
- `Distribución por pertenencia étnica`
- `Incidencia`

# sivirep 1.0.1

This patch release fixes the following items::

- `es_ES` was replaced with `es-ES` in the `DESCRIPTION` file.

- Updated function examples that require data import and
use the `cache` parameter to prevent an increase in the package's size
on CRAN.
46 changes: 26 additions & 20 deletions R/checking_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -907,13 +907,15 @@ agrupar_per_etn <- function(data_event, cols_etn = "per_etn",
#' data_limpia <- limpiar_data_sivigila(data_event = dengue2020)
#' # Cálculo de la incidencia con proyecciones poblacionales por departamento
#' data_agrupada_mpios <- agrupar_mpio(data_limpia, dpto = "Antioquia")
#' calcular_incidencia(
#' data_agrupada = data_agrupada_mpios,
#' poblacion = "proyecciones",
#' dpto = "05",
#' year = 2020,
#' cache = TRUE
#' )
#' if (interactive()) {
#' calcular_incidencia(
#' data_agrupada = data_agrupada_mpios,
#' poblacion = "proyecciones",
#' dpto = "05",
#' year = 2020,
#' cache = TRUE
#' )
#' }
#' # Cálculo de la incidencia con proyecciones poblacionales por municipio
#' calcular_incidencia(
#' data_agrupada = data_agrupada_mpios,
Expand All @@ -929,7 +931,7 @@ agrupar_per_etn <- function(data_event, cols_etn = "per_etn",
#' poblacion = "riesgo",
#' data_agrupada = data_agrupada_dptos,
#' year = 2020,
#' cache = TRUE
#' ruta_dir = tempdir()
#' )
#' }
#' @export
Expand Down Expand Up @@ -1068,12 +1070,14 @@ calcular_incidencia <- function(data_incidencia = NULL,
#' data_limpia <- limpiar_data_sivigila(data_event = dengue2020)
#' data_agrupada_mpios <- agrupar_mpio(data_limpia, dpto = "Antioquia")
#' # Cálculo de la incidencia con población a riesgo por departamento
#' calcular_incidencia_geo(
#' poblacion = "riesgo",
#' data_agrupada = data_agrupada_mpios,
#' year = 2020,
#' cache = TRUE
#' )
#' if (interactive()) {
#' calcular_incidencia_geo(
#' poblacion = "riesgo",
#' data_agrupada = data_agrupada_mpios,
#' year = 2020,
#' cache = TRUE
#' )
#' }
#' data_agrupada_dptos <- agrupar_dpto(data_limpia)
#' # Cálculo de la incidencia con proyecciones poblacionales para Colombia
#' calcular_incidencia_geo(
Expand Down Expand Up @@ -1219,12 +1223,14 @@ calcular_incidencia_geo <- function(data_incidencia = NULL,
#' dpto = "05"
#' )
#' data_agrupada <- agrupar_sex(data_filtrada)
#' calcular_incidencia_sex(
#' data_agrupada = data_agrupada,
#' dpto = "05",
#' year = 2020,
#' cache = TRUE
#' )
#' if (interactive()) {
#' calcular_incidencia_sex(
#' data_agrupada = data_agrupada,
#' dpto = "05",
#' year = 2020,
#' cache = TRUE
#' )
#' }
#' #' Cálculo de la incidencia con proyecciones poblacionales por sexo y
#' # municipio
#' data_filtrada <- geo_filtro(
Expand Down
12 changes: 10 additions & 2 deletions R/import_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -320,8 +320,10 @@ import_sep_data <- function(ruta_data = NULL,
#' @examples
#' \donttest{
#' # Importación proyecciones poblaciones DANE
#' import_pob_incidencia(poblacion = "proyecciones", year = 2020,
#' cache = TRUE)
#' if (interactive()) {
#' import_pob_incidencia(poblacion = "proyecciones", year = 2020,
#' cache = TRUE)
#' }
#' # Importación población a riesgo de Dengue del año 2020
#' import_pob_incidencia(poblacion = "riesgo", event = "dengue", year = 2020,
#' ruta_dir = tempdir())
Expand Down Expand Up @@ -360,6 +362,9 @@ import_pob_incidencia <- function(
#' @examples
#' \donttest{
#' import_pob_proyecciones(year = 2020, ruta_dir = tempdir())
#' if (interactive()) {
#' import_pob_proyecciones(year = 2020, cache = TRUE)
#' }
#' }
#' @export
import_pob_proyecciones <- function(year,
Expand Down Expand Up @@ -406,6 +411,9 @@ import_pob_proyecciones <- function(year,
#' @examples
#' \donttest{
#' import_pob_riesgo(event = "Dengue", year = 2020, ruta_dir = tempdir())
#' if (interactive()) {
#' import_pob_riesgo(event = "Dengue", year = 2020, cache = TRUE)
#' }
#' }
#' @export
import_pob_riesgo <- function(event, year,
Expand Down
30 changes: 17 additions & 13 deletions R/plotting.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,13 @@
#' geo_ocurrencia <- obtener_tip_ocurren_geo(nombre_event = "dengue")
#' data_espacial <- agrupar_dpto(data_event = data_estandar,
#' geo_ocurrencia[1:4])
#' plot_map(
#' data_agrupada = data_espacial,
#' col_distribucion = "casos",
#' cache = TRUE
#' )
#' if (interactive()) {
#' plot_map(
#' data_agrupada = data_espacial,
#' col_distribucion = "casos",
#' cache = TRUE
#' )
#' }
#' # Mapa por municipios de un departamento especifico
#' data_filtrada_dpto <- geo_filtro(
#' data_event = data_estandar,
Expand All @@ -53,14 +55,16 @@
#' mpio = "Medellin"
#' )
#' data_espacial_mpio <- agrupar_mpio(data_event = data_filtrada_mpio)
#' plot_map(
#' data_agrupada = data_espacial_mpio,
#' col_codigos = "cod_mun_o",
#' col_distribucion = "casos",
#' dpto = "Antioquia",
#' mpio = "Medellin",
#' cache = TRUE
#' )
#' if (interactive()) {
#' plot_map(
#' data_agrupada = data_espacial_mpio,
#' col_codigos = "cod_mun_o",
#' col_distribucion = "casos",
#' dpto = "Antioquia",
#' mpio = "Medellin",
#' cache = TRUE
#' )
#' }
#' # Mapa con la incidencia por municipios de un departamento específico
#' incidencia_dpto <-
#' calcular_incidencia_geo(data_agrupada = data_espacial_dpto,
Expand Down
40 changes: 5 additions & 35 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,9 @@

* This is a new release.

* sivirep currently has its documentation, function names, and website in
Spanish, as user testing in various regions of Colombia, such as the Chocó
region, revealed that having these components in English posed a
significant barrier. Many users in these areas are not proficient in English,
which increases learning curves and limits the adoption of the tool. This
package is expected to be used by Health Departments and Professionals
throughout the country to facilitate the generation and access to
epidemiological reports from SIVIGILA (National Public Health Surveillance
System).

## Resubmission

This is a resubmission. In this version:

* Expanded the Description field to provide a more detailed overview of the
package's functionality, benefits and the methods it implements, as requested.
* Updated `DESCRIPTION` file to use language tags compliant with RFC 5646.
Specifically, `es_ES` was replaced with `es-ES` as recommended.

* Added a direct link to the web services used in the package, formatted with
angle brackets for auto-linking, following the recommended format.

* Replaced `\dontrun{}` with `\donttest{}` in the examples of the following
functions: `import_data_event()`, `list_events()` and `plot_year()`.

* Added `\donttest{}` in examples of `import_geo_codes` function, since it was
involve data downloading and was the only function that did not have
this tag.

* Used `tempdir()` in examples and tests of functions that require data import
for execution.

* In the internal function `obtener_ruta_dir()` of `R\utils.R`, the `cache`
parameter was added, and the functions that use it were modified to always
pass it. This parameter requests explicit confirmation from the user if they
want the data to be stored in the respective user directory, which is
obtained from `tools::R_user_dir()`. These files are cleaned up and actively
managed in accordance with CRAN policy.
* Implemented `tempdir()` for function examples that require data import and
improved the use of `cache` parameter. These changes resolves additional
`donttest` issues related to package's size on CRAN.
18 changes: 10 additions & 8 deletions man/calcular_incidencia.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 8 additions & 6 deletions man/calcular_incidencia_geo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 8 additions & 6 deletions man/calcular_incidencia_sex.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions man/import_pob_incidencia.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/import_pob_proyecciones.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/import_pob_riesgo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 17 additions & 13 deletions man/plot_map.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading