Package 'dosr' reference manual

Title:	Survey Analysis Tools for the Chilean Social Observatory
Description:	Provides high-level functions to compute estimates (means, proportions, totals, ratios and quantiles) for complex survey designs, with automatic classification of statistical reliability, between-year significance tests and standardised report generation in 'Excel' format (via 'openxlsx'). It was developed for the Social Observatory ('Observatorio Social') of the Chilean Ministry of Social Development and implements its data-quality criteria, but it can be applied to any complex-survey design (for example the Chilean 'CASEN' household survey, included as example data). The reliability criteria follow Division Observatorio Social (2023) <https://bidat.gob.cl/details/ficha/dato/manual-para-la-investigacion-casen-2022> and Instituto Nacional de Estadisticas (2020) <https://www.ine.gob.cl/inicio/documentos-de-trabajo/documento/fundamentos-del-est%C3%A1ndar-para-la-evaluaci%C3%B3n-de-la-calidad-de-las-estimaciones-en-encuestas-de-hogares>; complex-survey estimation methods follow Lumley (2010, ISBN:9780470284308).
Authors:	Gabriel Sotomayor [aut, cre] (ORCID: <https://orcid.org/0000-0002-9889-9637>)
Maintainer:	Gabriel Sotomayor <[email protected]>
License:	MIT + file LICENSE
Version:	0.3.4
Built:	2026-07-07 08:20:12 UTC
Source:	https://github.com/gabrielsotomayorl/dosr

Encuesta CASEN 2022 — subconjunto de variables clave

Description

Subconjunto de la Encuesta de Caracterización Socioeconómica Nacional (CASEN) 2022, publicada por el Ministerio de Desarrollo Social y Familia de Chile. Contiene todas las observaciones de la encuesta original y las variables necesarias para ilustrar el uso de las funciones del paquete 'dosr'.

Usage

casen_2022
casen_2022

Format

Un 'data.frame' con 202.231 filas y 18 variables:

expr: Factor de expansión regional.
varstrat: Estratos de varianza (variable de estratificación para el diseño muestral).
varunit: Conglomerados de varianza (unidad primaria de muestreo).
region: Región (haven_labelled, 16 categorías).
area: Área: 1 = Urbano, 2 = Rural (haven_labelled).
sexo: Sexo: 1 = Hombre, 2 = Mujer (haven_labelled).
edad: Edad en años.
pobreza: Situación de pobreza por ingresos: 1 = Pobreza extrema, 2 = Pobreza no extrema, 3 = Fuera de la pobreza (haven_labelled).
ytotcorh: Ingreso total corregido del hogar (pesos chilenos).
activ: Condición de actividad: 1 = Ocupados, 2 = Desocupados, 3 = Inactivos (haven_labelled).
r8a: ¿Se preocupó por no tener suficientes alimentos por falta de dinero? (0 = No, 1 = Sí).
r8b: ¿No pudo comer alimentos saludables y nutritivos por falta de dinero? (0 = No, 1 = Sí).
r8c: ¿Comió poca variedad de alimentos por falta de dinero? (0 = No, 1 = Sí).
r8d: ¿Tuvo que dejar de desayunar, almorzar, tomar once o cenar por dinero? (0 = No, 1 = Sí).
r8e: ¿Comió menos de lo que pensaba que debía comer por falta de dinero? (0 = No, 1 = Sí).
r8f: ¿Se quedó sin alimentos por falta de dinero? (0 = No, 1 = Sí).
r8g: ¿Sintió hambre y no comió por falta de dinero? (0 = No, 1 = Sí).
r8h: ¿Dejó de comer todo un día por falta de dinero? (0 = No, 1 = Sí).

Source

Ministerio de Desarrollo Social y Familia, Chile. https://observatorio.ministeriodesarrollosocial.gob.cl/encuesta-casen

Encuesta CASEN 2024 — subconjunto de variables clave

Description

Subconjunto de la Encuesta de Caracterización Socioeconómica Nacional (CASEN) 2024, publicada por el Ministerio de Desarrollo Social y Familia de Chile. Contiene todas las observaciones de la encuesta original y las variables necesarias para ilustrar el uso de las funciones del paquete 'dosr'.

Usage

casen_2024
casen_2024

Format

Un 'data.frame' con 218.367 filas y 18 variables:

expr: Factor de expansión regional.
varstrat: Estratos de varianza (variable de estratificación para el diseño muestral).
varunit: Conglomerados de varianza (unidad primaria de muestreo).
region: Región (haven_labelled, 16 categorías).
area: Área: 1 = Urbano, 2 = Rural (haven_labelled).
sexo: Sexo: 1 = Hombre, 2 = Mujer (haven_labelled).
edad: Edad en años.
pobreza: Situación de pobreza por ingresos: 1 = Pobreza extrema, 2 = Pobreza no extrema, 3 = Fuera de la pobreza (haven_labelled).
ytotcorh: Ingreso total corregido del hogar (pesos chilenos).
activ: Condición de actividad: 1 = Ocupados, 2 = Desocupados, 3 = Inactivos (haven_labelled).
r8a: ¿Se preocupó por no tener suficientes alimentos por falta de dinero? (0 = No, 1 = Sí).
r8b: ¿No pudo comer alimentos saludables y nutritivos por falta de dinero? (0 = No, 1 = Sí).
r8c: ¿Comió poca variedad de alimentos por falta de dinero? (0 = No, 1 = Sí).
r8d: ¿Tuvo que dejar de desayunar, almorzar, tomar once o cenar por dinero? (0 = No, 1 = Sí).
r8e: ¿Comió menos de lo que pensaba que debía comer por falta de dinero? (0 = No, 1 = Sí).
r8f: ¿Se quedó sin alimentos por falta de dinero? (0 = No, 1 = Sí).
r8g: ¿Sintió hambre y no comió por falta de dinero? (0 = No, 1 = Sí).
r8h: ¿Dejó de comer todo un día por falta de dinero? (0 = No, 1 = Sí).

Source

Ministerio de Desarrollo Social y Familia, Chile. https://observatorio.ministeriodesarrollosocial.gob.cl/encuesta-casen

Perfilar Múltiples Variables Dicotómicas con Criterios de Calidad

Description

Para un **único diseño de encuesta**, calcula la proporción de "1s" para un vector de variables dicotómicas (0/1). Esta función es una herramienta de conveniencia para perfilados rápidos y análisis exploratorios. A diferencia de 'obs_prop', está optimizada para analizar múltiples variables dentro de una sola encuesta, pero no para comparar entre años. Genera un reporte en Excel con una hoja consolidada (con todas las métricas de calidad) y hojas de formato para el nivel nacional y cada desagregación simple.

Usage

multi_bin(
  design,
  vars_binarias,
  des = NULL,
  es_var_estudio = FALSE,
  filt = NULL,
  dir = NULL,
  filename = NULL,
  decimales = 1,
  decimales_se = 3,
  n_minimo = 30,
  verbose = TRUE
)
multi_bin(
  design,
  vars_binarias,
  des = NULL,
  es_var_estudio = FALSE,
  filt = NULL,
  dir = NULL,
  filename = NULL,
  decimales = 1,
  decimales_se = 3,
  n_minimo = 30,
  verbose = TRUE
)

Arguments

design

Un objeto 'tbl_svy' de 'srvyr'.

vars_binarias

Un vector de strings con los nombres de las variables dicotómicas (codificadas como 0/1) a perfilar.

des

Un vector de strings con los nombres de las variables de desagregación simple.

es_var_estudio

Booleano. Si 'TRUE', aplica criterios de fiabilidad menos estrictos para el tamaño muestral.

filt

Expresión de filtro. Acepta tanto una expresión R sin comillas ('filt = edad > 18') como un string ('filt = "edad > 18"'). Ambas formas son equivalentes y retrocompatibles.

dir

Un string con la ruta del directorio de salida. Obligatorio (no tiene valor por defecto, para no escribir en el directorio de trabajo sin consentimiento explícito). Use por ejemplo 'dir = tempdir()'. Se crea si no existe.

filename

Un string con el nombre del archivo Excel.

decimales

Entero. Número de decimales para la estimación puntual. Por defecto es 1.

decimales_se

Entero. Número de decimales para el error estándar. Por defecto es 3.

n_minimo

Entero. Tamaño muestral mínimo para clasificar una estimación como fiable. Por defecto es '30'.

verbose

Booleano. Si 'TRUE', muestra mensajes de progreso.

Value

Un data.frame con todos los resultados consolidados (invisiblemente).

Examples

library(srvyr)
library(dplyr)

# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_ays <- casen_2024 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)

# Prevalencia de indicadores de inseguridad alimentaria por área
multi_bin(design_ays, vars_binarias = paste0("r8", letters[1:8]),
          des = "area", dir = tempdir(), verbose = FALSE)
library(srvyr)
library(dplyr)

# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_ays <- casen_2024 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)

# Prevalencia de indicadores de inseguridad alimentaria por área
multi_bin(design_ays, vars_binarias = paste0("r8", letters[1:8]),
          des = "area", dir = tempdir(), verbose = FALSE)

Calcula estimaciones de cuantiles para diseños complejos

Description

Procesa uno o más 'tbl_svy' para calcular cuantiles.

Usage

obs_cuantil(
  designs,
  sufijo = NULL,
  var,
  cuant = 0.5,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)
obs_cuantil(
  designs,
  sufijo = NULL,
  var,
  cuant = 0.5,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)

Arguments

designs

Un objeto 'tbl_svy' o una lista de ellos.

sufijo

Vector de strings para sufijos (p.ej. c("2020","2022")).

var

Un string con el nombre de la variable de interés (numérica).

cuant

Probabilidad del cuantil a calcular. Debe estar entre 0 y 1. Por defecto '0.5' (mediana).

des

Un vector de strings con los nombres de las variables de desagregación.

multi_des

Booleano. Si 'TRUE' (por defecto), calcula todas las combinaciones de 'des'. Si 'FALSE', solo calcula las desagregaciones simples.

es_var_estudio

Booleano. Si 'TRUE', aplica criterios de fiabilidad menos estrictos para el tamaño muestral. Por defecto es 'FALSE'.

usar_etiqueta_var

Booleano. Si 'TRUE' (por defecto), usa la etiqueta de la variable 'var' como título en los reportes de Excel. Si es 'FALSE' o la variable no tiene etiqueta, usa el nombre de la variable.

sig

Booleano. Si 'TRUE', calcula y añade pruebas de significancia estadística a las hojas de reporte con formato. Por defecto es 'FALSE'.

filt

Expresión de filtro. Acepta tanto una expresión R sin comillas ('filt = edad > 18') como un string ('filt = "edad > 18"'). Ambas formas son equivalentes y retrocompatibles.

rm_na_var

Booleano. Si 'TRUE', elimina NAs en 'var' antes de calcular.

rm_na_des

Booleano. Si 'TRUE', excluye las observaciones con 'NA' en las variables de desagregación correspondientes a cada tabla solicitada.

parallel

Booleano. Activa el cálculo en paralelo. Con un único diseño y múltiples desagregaciones distribuye las combinaciones entre workers; con múltiples diseños distribuye los diseños. Por defecto 'FALSE'.

n_cores

Entero. Número de workers a usar. Si es 'NULL', se usa un valor seguro (máximo 4).

save_xlsx

Booleano. Si 'TRUE', guarda un reporte en Excel.

dir

Un string con la ruta del directorio donde se guardará el archivo Excel. Obligatorio cuando 'save_xlsx = TRUE' (no tiene valor por defecto, para no escribir en el directorio de trabajo sin consentimiento explícito). Use por ejemplo 'dir = tempdir()' o una ruta de su proyecto. Se crea si no existe.

formato

Booleano. Si 'TRUE', genera un reporte de Excel con formato avanzado.

decimales

Entero. Número de decimales para las estimaciones en Excel.

nombre

String. Nombre del indicador que se muestra en el reporte Excel. Si se especifica, sobrescribe la etiqueta de variable aunque 'usar_etiqueta_var = TRUE'.

fuente

String. Fuente de los datos para el pie del reporte Excel. Acepta claves estándar ('"casen"', '"ebs"', '"endide"', '"eanna"', '"elpi"') o texto libre.

snac

Booleano. Si 'TRUE', omite la hoja de formato del nivel nacional. El consolidado siempre incluye el nivel nacional. Por defecto 'FALSE'.

mostrar_pct_fiable

Booleano. Si 'TRUE', la nota de fiabilidad incluye el porcentaje de estimaciones fiables del cuadro. Por defecto 'FALSE'.

color_fiabilidad

Booleano. Si 'TRUE', colorea el texto de las celdas de estimación según su fiabilidad: ámbar para poco fiable, rojo para no fiable. Por defecto 'FALSE'.

universo_crit

Booleano. Solo aplica a 'obs_prop'. Si 'TRUE', fuerza el uso del N total del dominio (suma de categorías) para el criterio muestral de fiabilidad, independientemente del número de categorías. Por defecto 'FALSE' (comportamiento automático).

cv_umbral_alto

Numérico. Umbral de CV para clasificar una estimación como "No Fiable (CV)". Por defecto '0.30'.

cv_umbral_medio

Numérico. Umbral de CV para clasificar una estimación como "Poco Fiable (CV)". Por defecto '0.20'.

n_minimo

Entero. Tamaño muestral mínimo para el criterio de fiabilidad. Por defecto '30'.

nivel_confianza

Numérico. Nivel de confianza para intervalos y pruebas de significancia. Por defecto '0.95'.

verbose

Booleano. Si 'TRUE' (por defecto), muestra mensajes de progreso.

Value

Un data.frame con los resultados consolidados (invisiblemente).

Examples

library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_cuantil(design_2022, sufijo = "2022", var = "ytotcorh", cuant = 0.5,
            save_xlsx = FALSE, verbose = FALSE)
library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_cuantil(design_2022, sufijo = "2022", var = "ytotcorh", cuant = 0.5,
            save_xlsx = FALSE, verbose = FALSE)

Calcula estimaciones de medias para diseños complejos

Description

Procesa uno o más 'tbl_svy' para calcular medias.

Usage

obs_media(
  designs,
  sufijo = NULL,
  var,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)
obs_media(
  designs,
  sufijo = NULL,
  var,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)

Arguments

designs

Un objeto 'tbl_svy' o una lista de ellos.

sufijo

Vector de strings para sufijos (p.ej. c("2020","2022")).

var

Un string con el nombre de la variable de interés (numérica).

des

Un vector de strings con los nombres de las variables de desagregación.

multi_des

Booleano. Si 'TRUE' (por defecto), calcula todas las combinaciones de 'des'. Si 'FALSE', solo calcula las desagregaciones simples.

es_var_estudio

Booleano. Si 'TRUE', aplica criterios de fiabilidad menos estrictos para el tamaño muestral. Por defecto es 'FALSE'.

usar_etiqueta_var

Booleano. Si 'TRUE' (por defecto), usa la etiqueta de la variable 'var' como título en los reportes de Excel. Si es 'FALSE' o la variable no tiene etiqueta, usa el nombre de la variable.

sig

Booleano. Si 'TRUE', calcula y añade pruebas de significancia estadística a las hojas de reporte con formato. Por defecto es 'FALSE'.

filt

Expresión de filtro. Acepta tanto una expresión R sin comillas ('filt = edad > 18') como un string ('filt = "edad > 18"'). Ambas formas son equivalentes y retrocompatibles.

rm_na_var

Booleano. Si 'TRUE', elimina NAs en 'var' antes de calcular.

rm_na_des

Booleano. Si 'TRUE', excluye las observaciones con 'NA' en las variables de desagregación correspondientes a cada tabla solicitada.

parallel

n_cores

Entero. Número de workers a usar. Si es 'NULL', se usa un valor seguro (máximo 4).

save_xlsx

Booleano. Si 'TRUE', guarda un reporte en Excel.

dir

formato

Booleano. Si 'TRUE', genera un reporte de Excel con formato avanzado.

decimales

Entero. Número de decimales para las estimaciones en Excel.

nombre

String. Nombre del indicador que se muestra en el reporte Excel. Si se especifica, sobrescribe la etiqueta de variable aunque 'usar_etiqueta_var = TRUE'.

fuente

String. Fuente de los datos para el pie del reporte Excel. Acepta claves estándar ('"casen"', '"ebs"', '"endide"', '"eanna"', '"elpi"') o texto libre.

snac

Booleano. Si 'TRUE', omite la hoja de formato del nivel nacional. El consolidado siempre incluye el nivel nacional. Por defecto 'FALSE'.

mostrar_pct_fiable

Booleano. Si 'TRUE', la nota de fiabilidad incluye el porcentaje de estimaciones fiables del cuadro. Por defecto 'FALSE'.

color_fiabilidad

Booleano. Si 'TRUE', colorea el texto de las celdas de estimación según su fiabilidad: ámbar para poco fiable, rojo para no fiable. Por defecto 'FALSE'.

universo_crit

cv_umbral_alto

Numérico. Umbral de CV para clasificar una estimación como "No Fiable (CV)". Por defecto '0.30'.

cv_umbral_medio

Numérico. Umbral de CV para clasificar una estimación como "Poco Fiable (CV)". Por defecto '0.20'.

n_minimo

Entero. Tamaño muestral mínimo para el criterio de fiabilidad. Por defecto '30'.

nivel_confianza

Numérico. Nivel de confianza para intervalos y pruebas de significancia. Por defecto '0.95'.

verbose

Booleano. Si 'TRUE' (por defecto), muestra mensajes de progreso.

Value

Un data.frame con los resultados consolidados (invisiblemente).

Examples

library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_media(design_2022, sufijo = "2022", var = "ytotcorh",
          save_xlsx = FALSE, verbose = FALSE)
library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_media(design_2022, sufijo = "2022", var = "ytotcorh",
          save_xlsx = FALSE, verbose = FALSE)

Calcula estimaciones de proporciones para diseños complejos

Description

Procesa uno o más 'tbl_svy' para calcular proporciones.

Usage

obs_prop(
  designs,
  sufijo = NULL,
  var,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  porcentaje = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  categoria = NULL,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)
obs_prop(
  designs,
  sufijo = NULL,
  var,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  porcentaje = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  categoria = NULL,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)

Arguments

designs

Un objeto 'tbl_svy' o una lista de ellos.

sufijo

Vector de strings para sufijos (p.ej. c("2020","2022")).

var

Un string con el nombre de la variable de interés (numérica).

des

Un vector de strings con los nombres de las variables de desagregación.

multi_des

Booleano. Si 'TRUE' (por defecto), calcula todas las combinaciones de 'des'. Si 'FALSE', solo calcula las desagregaciones simples.

es_var_estudio

Booleano. Si 'TRUE', aplica criterios de fiabilidad menos estrictos para el tamaño muestral. Por defecto es 'FALSE'.

usar_etiqueta_var

Booleano. Si 'TRUE' (por defecto), usa la etiqueta de la variable 'var' como título en los reportes de Excel. Si es 'FALSE' o la variable no tiene etiqueta, usa el nombre de la variable.

sig

Booleano. Si 'TRUE', calcula y añade pruebas de significancia estadística a las hojas de reporte con formato. Por defecto es 'FALSE'.

filt

Expresión de filtro. Acepta tanto una expresión R sin comillas ('filt = edad > 18') como un string ('filt = "edad > 18"'). Ambas formas son equivalentes y retrocompatibles.

rm_na_var

Booleano. Si 'TRUE', elimina NAs en 'var' antes de calcular.

rm_na_des

Booleano. Si 'TRUE', excluye las observaciones con 'NA' en las variables de desagregación correspondientes a cada tabla solicitada.

parallel

n_cores

Entero. Número de workers a usar. Si es 'NULL', se usa un valor seguro (máximo 4).

save_xlsx

Booleano. Si 'TRUE', guarda un reporte en Excel.

dir

formato

Booleano. Si 'TRUE', genera un reporte de Excel con formato avanzado.

porcentaje

Booleano. Si 'TRUE', las estimaciones y errores estándar se multiplican por 100.

decimales

Entero. Número de decimales para las estimaciones en Excel.

nombre

String. Nombre del indicador que se muestra en el reporte Excel. Si se especifica, sobrescribe la etiqueta de variable aunque 'usar_etiqueta_var = TRUE'.

fuente

String. Fuente de los datos para el pie del reporte Excel. Acepta claves estándar ('"casen"', '"ebs"', '"endide"', '"eanna"', '"elpi"') o texto libre.

snac

Booleano. Si 'TRUE', omite la hoja de formato del nivel nacional. El consolidado siempre incluye el nivel nacional. Por defecto 'FALSE'.

mostrar_pct_fiable

Booleano. Si 'TRUE', la nota de fiabilidad incluye el porcentaje de estimaciones fiables del cuadro. Por defecto 'FALSE'.

color_fiabilidad

Booleano. Si 'TRUE', colorea el texto de las celdas de estimación según su fiabilidad: ámbar para poco fiable, rojo para no fiable. Por defecto 'FALSE'.

universo_crit

categoria

Vector de valores (labels o códigos numéricos) para filtrar las categorías de 'var' a mostrar en el output. Las demás categorías se excluyen del resultado y del reporte Excel.

cv_umbral_alto

Numérico. Umbral de CV para clasificar una estimación como "No Fiable (CV)". Por defecto '0.30'.

cv_umbral_medio

Numérico. Umbral de CV para clasificar una estimación como "Poco Fiable (CV)". Por defecto '0.20'.

n_minimo

Entero. Tamaño muestral mínimo para el criterio de fiabilidad. Por defecto '30'.

nivel_confianza

Numérico. Nivel de confianza para intervalos y pruebas de significancia. Por defecto '0.95'.

verbose

Booleano. Si 'TRUE' (por defecto), muestra mensajes de progreso.

Value

Un data.frame con los resultados consolidados (invisiblemente).

Examples

library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_prop(design_2022, sufijo = "2022", var = "pobreza",
         porcentaje = TRUE, save_xlsx = FALSE, verbose = FALSE)
library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_prop(design_2022, sufijo = "2022", var = "pobreza",
         porcentaje = TRUE, save_xlsx = FALSE, verbose = FALSE)

Calcula razones (ratios) para diseños complejos

Description

Calcula la razón entre dos variables numéricas (numerador/denominador) sobre uno o más objetos 'tbl_svy', con las mismas opciones de desagregación, paralelización y reporte usadas en 'obs_media'.

Usage

obs_ratio(
  designs,
  sufijo = NULL,
  num,
  den,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)
obs_ratio(
  designs,
  sufijo = NULL,
  num,
  den,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)

Arguments

designs

Un objeto 'tbl_svy' o una lista de ellos.

sufijo

Vector de strings para sufijos (p.ej. c("2020","2022")).

num

String con el nombre de la variable **numerador**.

den

String con el nombre de la variable **denominador**.

des

Un vector de strings con los nombres de las variables de desagregación.

multi_des

Booleano. Si 'TRUE' (por defecto), calcula todas las combinaciones de 'des'. Si 'FALSE', solo calcula las desagregaciones simples.

es_var_estudio

Booleano. Si 'TRUE', aplica criterios de fiabilidad menos estrictos para el tamaño muestral. Por defecto es 'FALSE'.

usar_etiqueta_var

Booleano. Si 'TRUE' (por defecto), usa las etiquetas de las variables 'num' y 'den' (si existen) como títulos y rótulos en los reportes de Excel; si no hay etiqueta disponible, usa el nombre de la variable.

sig

Booleano. Si 'TRUE', calcula y añade pruebas de significancia estadística a las hojas de reporte con formato. Por defecto es 'FALSE'.

filt

Expresión de filtro. Acepta tanto una expresión R sin comillas ('filt = edad > 18') como un string ('filt = "edad > 18"'). Ambas formas son equivalentes y retrocompatibles.

rm_na_var

Booleano. Si 'TRUE', elimina observaciones con 'NA' en el **numerador o** el **denominador** antes de calcular la razón.

rm_na_des

Booleano. Si 'TRUE', excluye las observaciones con 'NA' en las variables de desagregación correspondientes a cada tabla solicitada.

parallel

n_cores

Entero. Número de workers a usar. Si es 'NULL', se usa un valor seguro (máximo 4).

save_xlsx

Booleano. Si 'TRUE', guarda un reporte en Excel.

dir

formato

Booleano. Si 'TRUE', genera un reporte de Excel con formato avanzado.

decimales

Entero. Número de decimales para las estimaciones en Excel.

nombre

String. Nombre del indicador que se muestra en el reporte Excel. Si se especifica, sobrescribe la etiqueta de variable aunque 'usar_etiqueta_var = TRUE'.

fuente

String. Fuente de los datos para el pie del reporte Excel. Acepta claves estándar ('"casen"', '"ebs"', '"endide"', '"eanna"', '"elpi"') o texto libre.

snac

Booleano. Si 'TRUE', omite la hoja de formato del nivel nacional. El consolidado siempre incluye el nivel nacional. Por defecto 'FALSE'.

mostrar_pct_fiable

Booleano. Si 'TRUE', la nota de fiabilidad incluye el porcentaje de estimaciones fiables del cuadro. Por defecto 'FALSE'.

color_fiabilidad

Booleano. Si 'TRUE', colorea el texto de las celdas de estimación según su fiabilidad: ámbar para poco fiable, rojo para no fiable. Por defecto 'FALSE'.

universo_crit

cv_umbral_alto

Numérico. Umbral de CV para clasificar una estimación como "No Fiable (CV)". Por defecto '0.30'.

cv_umbral_medio

Numérico. Umbral de CV para clasificar una estimación como "Poco Fiable (CV)". Por defecto '0.20'.

n_minimo

Entero. Tamaño muestral mínimo para el criterio de fiabilidad. Por defecto '30'.

nivel_confianza

Numérico. Nivel de confianza para intervalos y pruebas de significancia. Por defecto '0.95'.

verbose

Booleano. Si 'TRUE' (por defecto), muestra mensajes de progreso.

Value

Un 'data.frame' con los resultados consolidados (invisiblemente).

Examples

library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
design_2022$variables <- design_2022$variables %>%
  mutate(mujer  = as.integer(as.numeric(sexo) == 2),
         hombre = as.integer(as.numeric(sexo) == 1))
obs_ratio(design_2022, sufijo = "2022", num = "mujer", den = "hombre",
          save_xlsx = FALSE, verbose = FALSE)
library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
design_2022$variables <- design_2022$variables %>%
  mutate(mujer  = as.integer(as.numeric(sexo) == 2),
         hombre = as.integer(as.numeric(sexo) == 1))
obs_ratio(design_2022, sufijo = "2022", num = "mujer", den = "hombre",
          save_xlsx = FALSE, verbose = FALSE)

Calcula estimaciones de totales para diseños complejos

Description

Procesa uno o más 'tbl_svy' para calcular totales ponderados.

Usage

obs_total(
  designs,
  sufijo = NULL,
  var,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)
obs_total(
  designs,
  sufijo = NULL,
  var,
  des = NULL,
  multi_des = TRUE,
  es_var_estudio = FALSE,
  usar_etiqueta_var = TRUE,
  sig = FALSE,
  filt = NULL,
  rm_na_var = TRUE,
  rm_na_des = FALSE,
  parallel = FALSE,
  n_cores = NULL,
  save_xlsx = TRUE,
  dir = NULL,
  formato = TRUE,
  decimales = 2,
  nombre = NULL,
  fuente = NULL,
  snac = FALSE,
  mostrar_pct_fiable = FALSE,
  color_fiabilidad = FALSE,
  universo_crit = FALSE,
  cv_umbral_alto = 0.3,
  cv_umbral_medio = 0.2,
  n_minimo = 30L,
  nivel_confianza = 0.95,
  verbose = TRUE
)

Arguments

designs

Un objeto 'tbl_svy' o una lista de ellos.

sufijo

Vector de strings para sufijos (p.ej. c("2020","2022")).

var

Un string con el nombre de la variable de interés (numérica).

des

Un vector de strings con los nombres de las variables de desagregación.

multi_des

Booleano. Si 'TRUE' (por defecto), calcula todas las combinaciones de 'des'. Si 'FALSE', solo calcula las desagregaciones simples.

es_var_estudio

Booleano. Si 'TRUE', aplica criterios de fiabilidad menos estrictos para el tamaño muestral. Por defecto es 'FALSE'.

usar_etiqueta_var

Booleano. Si 'TRUE' (por defecto), usa la etiqueta de la variable 'var' como título en los reportes de Excel. Si es 'FALSE' o la variable no tiene etiqueta, usa el nombre de la variable.

sig

Booleano. Si 'TRUE', calcula y añade pruebas de significancia estadística a las hojas de reporte con formato. Por defecto es 'FALSE'.

filt

Expresión de filtro. Acepta tanto una expresión R sin comillas ('filt = edad > 18') como un string ('filt = "edad > 18"'). Ambas formas son equivalentes y retrocompatibles.

rm_na_var

Booleano. Si 'TRUE', elimina NAs en 'var' antes de calcular.

rm_na_des

Booleano. Si 'TRUE', excluye las observaciones con 'NA' en las variables de desagregación correspondientes a cada tabla solicitada.

parallel

n_cores

Entero. Número de workers a usar. Si es 'NULL', se usa un valor seguro (máximo 4).

save_xlsx

Booleano. Si 'TRUE', guarda un reporte en Excel.

dir

formato

Booleano. Si 'TRUE', genera un reporte de Excel con formato avanzado.

decimales

Entero. Número de decimales para las estimaciones en Excel.

nombre

String. Nombre del indicador que se muestra en el reporte Excel. Si se especifica, sobrescribe la etiqueta de variable aunque 'usar_etiqueta_var = TRUE'.

fuente

String. Fuente de los datos para el pie del reporte Excel. Acepta claves estándar ('"casen"', '"ebs"', '"endide"', '"eanna"', '"elpi"') o texto libre.

snac

Booleano. Si 'TRUE', omite la hoja de formato del nivel nacional. El consolidado siempre incluye el nivel nacional. Por defecto 'FALSE'.

mostrar_pct_fiable

Booleano. Si 'TRUE', la nota de fiabilidad incluye el porcentaje de estimaciones fiables del cuadro. Por defecto 'FALSE'.

color_fiabilidad

Booleano. Si 'TRUE', colorea el texto de las celdas de estimación según su fiabilidad: ámbar para poco fiable, rojo para no fiable. Por defecto 'FALSE'.

universo_crit

cv_umbral_alto

Numérico. Umbral de CV para clasificar una estimación como "No Fiable (CV)". Por defecto '0.30'.

cv_umbral_medio

Numérico. Umbral de CV para clasificar una estimación como "Poco Fiable (CV)". Por defecto '0.20'.

n_minimo

Entero. Tamaño muestral mínimo para el criterio de fiabilidad. Por defecto '30'.

nivel_confianza

Numérico. Nivel de confianza para intervalos y pruebas de significancia. Por defecto '0.95'.

verbose

Booleano. Si 'TRUE' (por defecto), muestra mensajes de progreso.

Value

Un data.frame con los resultados consolidados (invisiblemente).

Examples

library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_total(design_2022, sufijo = "2022", var = "ytotcorh",
          save_xlsx = FALSE, verbose = FALSE)
library(srvyr)
library(dplyr)
# Se usa una región pequeña (Aysén) para un ejemplo rápido;
# con la base completa el uso es idéntico.
design_2022 <- casen_2022 %>%
  filter(region == 11) %>%
  as_survey_design(ids = varunit, strata = varstrat,
                   weights = expr, nest = TRUE)
obs_total(design_2022, sufijo = "2022", var = "ytotcorh",
          save_xlsx = FALSE, verbose = FALSE)

Package 'dosr'

Help Index

Encuesta CASEN 2022 — subconjunto de variables clave

Description

Usage

Format

Source

Encuesta CASEN 2024 — subconjunto de variables clave

Description

Usage

Format

Source

Perfilar Múltiples Variables Dicotómicas con Criterios de Calidad

Description

Usage

Arguments

Value

Examples

Calcula estimaciones de cuantiles para diseños complejos

Description

Usage

Arguments

Value

Examples

Calcula estimaciones de medias para diseños complejos

Description

Usage

Arguments

Value

Examples

Calcula estimaciones de proporciones para diseños complejos

Description

Usage

Arguments

Value

Examples

Calcula razones (ratios) para diseños complejos

Description

Usage

Arguments

Value

Examples

Calcula estimaciones de totales para diseños complejos

Description

Usage

Arguments

Value

Examples