Compute Starting Points from Microdata
Source:R/mensalize-sidra-series.R
compute_series_starting_points.RdFor advanced users who want to compute custom starting points using their own calibrated microdata estimates.
Usage
compute_series_starting_points(
monthly_estimates,
rolling_quarters,
calibration_start = NULL,
calibration_end = NULL,
scale_factor = 1000,
use_series_specific_periods = TRUE,
verbose = TRUE
)Arguments
- monthly_estimates
data.table with columns:
anomesexato: YYYYMM exact monthz_<series>: Monthly estimates from calibrated microdata
- rolling_quarters
data.table from
fetch_sidra_rolling_quarters- calibration_start
Integer. Start of calibration period (YYYYMM). Default NULL uses .PNADC_DATES$DEFAULT_CALIB_START (201301). Note: CNPJ series automatically use CNPJ_CALIB_START (201601) regardless.
- calibration_end
Integer. End of calibration period (YYYYMM). Default NULL uses .PNADC_DATES$DEFAULT_CALIB_END (201912).
- scale_factor
Numeric. Scale factor for z_ values (usually 1000). Default 1000.
- use_series_specific_periods
Logical. If TRUE (default), use series-specific calibration periods for CNPJ series (201601-201912) and cumsum starting dates (201510). Set to FALSE to use uniform calibration for all series.
- verbose
Logical. Print progress? Default TRUE.
Value
data.table with columns:
- series_name
Character. Series name
- mesnotrim
Integer. Month position (1, 2, or 3)
- y0
Numeric. Starting point value
Details
The starting points (y0) are computed by:
Calculating cumulative variations from SIDRA rolling quarters
Computing backprojection: e0 = z / scale_factor - cum
Averaging e0 by mesnotrim over the calibration period
Series-Specific Handling
When use_series_specific_periods = TRUE, the following series receive
special handling for series-specific data availability:
- CNPJ series
empregadorcomcnpj, empregadorsemcnpj, contapropriacomcnpj, contapropriasemcnpj use calibration period 201601-201912 and cumsum starts from 201510 (when V4019 became available)
Examples
if (FALSE) { # \dontrun{
# After calibrating microdata with pnadc_apply_periods():
# monthly_est <- compute_monthly_estimates(calibrated_data)
# rq <- fetch_sidra_rolling_quarters()
# y0 <- compute_series_starting_points(monthly_est, rq)
# monthly <- mensalize_sidra_series(rq, starting_points = y0)
} # }