Package {svySE}

Type: Package
Title: Sampling Error Estimation for Complex Surveys
Version: 0.1.0
Description: Tools for estimating sampling errors of indicators from complex survey designs. The package supports weighted totals, proportions, standard errors, confidence intervals, coefficients of variation, design effects, unweighted counts, grouped estimates, domain estimates, configurable survey settings, and customizable Excel exports.
License: MIT + file LICENSE
Encoding: UTF-8
Language: en-US
Depends: R (≥ 4.2.0)
Imports: survey, openxlsx, stats
Suggests: testthat (≥ 3.0.0), knitr, rmarkdown
VignetteBuilder: knitr
Config/testthat/edition: 3
URL: https://github.com/lburgoss/svySE
BugReports: https://github.com/lburgoss/svySE/issues
Config/roxygen2/version: 8.0.0
NeedsCompilation: no
Packaged: 2026-07-03 19:32:32 UTC; encal154
Author: Luis Burgos [aut, cre]
Maintainer: Luis Burgos <lburgoss1996@gmail.com>
Repository: CRAN
Date/Publication: 2026-07-10 20:50:02 UTC

Print svySE configuration

Description

Imprime la configuracion de svySE. Prints the svySE configuration.

Usage

## S3 method for class 'svySE_cfg'
print(x, ...)

Arguments

x

Objeto de clase "svySE_cfg".

...

Argumentos adicionales.

Value

Invisiblemente el objeto x.

Print svySE result

Description

Imprime un resumen del resultado de svySE_calc().

Usage

## S3 method for class 'svySE_result'
print(x, ...)

Arguments

x

Objeto de clase "svySE_result".

...

Argumentos adicionales.

Details

Prints a summary of the result from svySE_calc().

Value

Invisiblemente x.

Calculate sampling errors

Description

Calcula errores muestrales para uno o mas indicadores usando un data.frame previamente cargado por el usuario.

Usage

svySE_calc(
  data,
  indicators,
  group_vars,
  group_labels = group_vars,
  strata,
  weight,
  division = NULL,
  div_weight = NULL,
  cfg = svySE_cfg(),
  verbose = TRUE,
  strict = FALSE
)

Arguments

data

Base de datos ya cargada en R / Data frame already loaded in R.

indicators

Vector con los nombres de los indicadores.

group_vars

Variables de agrupacion.

group_labels

Etiquetas de las variables de agrupacion.

strata

Variable o variables de estrato.

weight

Variable de peso principal.

division

Variable de division opcional.

div_weight

Variable de peso opcional para las divisiones.

cfg

Configuracion creada con svySE_cfg().

verbose

Si es TRUE, imprime avance del calculo.

strict

Si es TRUE, detiene el calculo cuando encuentra valores fuera de cfg$valid_values; si es FALSE, los excluye con advertencia.

Details

Calculates sampling errors for one or more indicators using a data.frame previously loaded by the user.

Value

Objeto de clase "svySE_result".

Configure sampling error parameters

Description

Crea una configuracion general para el calculo de errores muestrales. Creates a general configuration object for sampling error estimation.

Usage

svySE_cfg(
  estimator = "prop",
  variance = "taylor",
  lonely_psu = "adjust",
  conf_level = 0.95,
  target = 1,
  valid_values = c(0, 1),
  truncate_lower_ci = TRUE,
  pct_mult = 100,
  deff = TRUE,
  cv = TRUE,
  na_rm = TRUE
)

Arguments

estimator

Tipo de estimador. Opciones: "prop", "total", "mean" o "ratio".

variance

Metodo de estimacion de varianza. Actualmente solo "taylor".

lonely_psu

Tratamiento de estratos con una sola UPM. Opciones: "adjust", "average", "certainty", "remove" o "fail".

conf_level

Nivel de confianza. Por defecto 0.95.

target

Valor objetivo del indicador. Por defecto 1.

valid_values

Valores validos del indicador. Por defecto c(0, 1).

truncate_lower_ci

Si es TRUE, trunca el limite inferior del IC en cero.

pct_mult

Multiplicador para expresar proporciones como porcentajes. Por defecto 100.

deff

Si es TRUE, calcula efecto de diseno cuando sea posible.

cv

Si es TRUE, calcula coeficiente de variacion.

na_rm

Si es TRUE, remueve valores perdidos en operaciones auxiliares.

Value

Lista de clase "svySE_cfg".

Examples

cfg <- svySE_cfg(
  estimator = "prop",
  variance = "taylor",
  target = 1
)

Check logical scalar

Description

Valida que un argumento sea logico de longitud uno. Checks whether an argument is a single logical value.

Usage

svySE_chk_bool(x, arg)

Arguments

x

Objeto a validar / Object to validate.

arg

Nombre del argumento / Argument name.

Value

Invisiblemente TRUE.

Check selected columns

Description

Valida que las columnas seleccionadas existan dentro del conjunto permitido. Checks whether selected columns exist in the allowed column set.

Usage

svySE_chk_cols(cols, all_cols, arg = "cols")

Arguments

cols

Columnas seleccionadas / Selected columns.

all_cols

Columnas disponibles / Available columns.

arg

Nombre del argumento / Argument name.

Value

Invisiblemente TRUE.

Select sampling error columns

Description

Selecciona columnas para exportar la tabla de errores muestrales. Selects columns to export the sampling error table.

Usage

svySE_cols_err(type = "full", cols = NULL)

Arguments

type

Tipo de salida / Output type. Opciones: "full", "pct", "abs", "basic", "quality" o "custom".

cols

Vector de columnas cuando type = "custom".

Value

Vector de columnas seleccionadas / Selected column vector.

Examples

svySE_cols_err("full")
svySE_cols_err("pct")
svySE_cols_err("custom", cols = c("est_pct", "cv"))

Available sampling error columns

Description

Devuelve todas las columnas metricas disponibles para la tabla de errores muestrales. Returns all available metric columns for the sampling error table.

Usage

svySE_cols_err_all()

Value

Vector de nombres de columnas / Character vector of column names.

Select simple table columns

Description

Selecciona columnas para exportar la tabla simple. Selects columns to export the simple table.

Usage

svySE_cols_tab(type = "full", cols = NULL)

Arguments

type

Tipo de salida / Output type. Opciones: "full", "target", "freq", "pct" o "custom".

cols

Vector de columnas cuando type = "custom".

Value

Vector de columnas seleccionadas / Selected column vector.

Examples

svySE_cols_tab("full")
svySE_cols_tab("target")
svySE_cols_tab("custom", cols = c("freq_1", "pct_1"))

Available simple table columns

Description

Devuelve todas las columnas disponibles para la tabla simple. Returns all available columns for the simple table.

Usage

svySE_cols_tab_all()

Value

Vector de nombres de columnas / Character vector of column names.

Check svySE configuration object

Description

Verifica si un objeto pertenece a la clase svySE_cfg. Checks whether an object belongs to class svySE_cfg.

Usage

svySE_is_cfg(x)

Arguments

x

Objeto a evaluar / Object to check.

Value

TRUE o FALSE.

Export svySE results to Excel

Description

Exporta los resultados generados por svySE_calc() a archivos Excel. Exports results generated by svySE_calc() to Excel files.

Usage

svySE_xlsx(
  x,
  file_err = "svySE_errors.xlsx",
  file_tab = "svySE_simple.xlsx",
  cols_err = svySE_cols_err("full"),
  cols_tab = svySE_cols_tab("full"),
  start_row = 10,
  overwrite = TRUE,
  keep_na = FALSE
)

Arguments

x

Objeto generado por svySE_calc().

file_err

Archivo Excel para errores muestrales.

file_tab

Archivo Excel para tabla simple.

cols_err

Columnas de error a exportar.

cols_tab

Columnas de tabla simple a exportar.

start_row

Fila inicial de escritura.

overwrite

Sobrescribir archivos existentes.

keep_na

Mantener NA en Excel.

Value

Invisiblemente TRUE.