compute_series_starting_points: Compute Starting Points from Microdata

View source: R/mensalize-sidra-series.R

compute_series_starting_pointsR Documentation

Compute Starting Points from Microdata

Description

For 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 month

  • z_*: Monthly estimates from calibrated microdata (one column per series)

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.

Details

The starting points (y0) are computed by:

  1. Calculating cumulative variations from SIDRA rolling quarters

  2. Computing backprojection: e0 = z / scale_factor - cum

  3. Averaging e0 by mesnotrim over the calibration period

Value

data.table with columns:

series_name

Character. Series name

mesnotrim

Integer. Month position (1, 2, or 3)

y0

Numeric. Starting point value

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

## Not run: 
rq <- fetch_sidra_rolling_quarters()
z_agg <- compute_z_aggregates(calibrated_data)
y0 <- compute_series_starting_points(z_agg, rq)
monthly <- mensalize_sidra_series(rq, starting_points = y0)

## End(Not run)


PNADCperiods documentation built on April 28, 2026, 9:07 a.m.