generate.bage_ssvd: Generate Random Age or Age-Sex Profiles

View source: R/bage_ssvd-methods.R

generate.bage_ssvdR Documentation

Generate Random Age or Age-Sex Profiles

Description

Generate random age or age-sex profiles from an object of class "bage_ssvd". An object of class "bage_ssvd" holds results from an SVD decomposition of demographic data.

Usage

## S3 method for class 'bage_ssvd'
generate(
  x,
  v = NULL,
  n_draw = 20,
  n_comp = NULL,
  indep = NULL,
  age_labels = NULL,
  ...
)

Arguments

x

An object of class "bage_ssvd".

v

Version of data to use.

n_draw

Number of random draws to generate.

n_comp

The number of components. The default is half the total number of components of object.

indep

Whether to use independent or joint SVDs for each sex/gender, if the data contains a sex/gender variable. The default is to use independent SVDs. To obtain results for the total population when the data contains a sex/gender variable, set indep to NA.

age_labels

Age labels for the desired age or age-sex profile. If no labels are supplied, the most detailed profile available is used.

...

Unused. Included for generic consistency only.

Value

A tibble

Scaled SVDs of demographic databases in bage

See Also

  • components() Components used by SVD prior.

  • SVD() SVD prior for term involving age.

  • SVD_AR1(), SVD_AR(), SVD_RW(), SVD_RW2() Dynamic SVD priors for terms involving age and time.

  • poputils::age_labels() Generate age labels.

Examples

## females and males modeled independently
generate(HMD) 

## joint model for females and males
generate(HMD, indep = FALSE) 

## SVD for females and males combined
generate(HMD, indep = NA)

## specify age groups
labels <- poputils::age_labels(type = "lt", max = 60)
generate(HMD, age_labels = labels)

bage documentation built on Nov. 19, 2025, 9:07 a.m.