ha.inputs.lifetime.partners: Extract Goals ASM behavioral inputs

View source: R/extract-ha.R

ha.inputs.lifetime.partnersR Documentation

Extract Goals ASM behavioral inputs

Description

Extract Goals ASM behavioral inputs

Usage

ha.inputs.lifetime.partners(
  ha.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

ha.inputs.partner.age(ha.raw, direction = "wide")

ha.inputs.partner.age.par(ha.raw, direction = "wide")

ha.inputs.mixing.age(ha.raw, direction = "wide")

Arguments

ha.raw

Goals ASM module data in raw format, as returned by read.raw.ha()

direction

Request "wide" (default) or "long" format data.

first.year

First year of the projection. If first.year=NULL, it will be filled in using ha.inputs.first.year()

final.year

Final year of the projection. If final.year=NULL, it will be filled in using ha.inputs.final.year()

Value

a data frame

Functions

  • ha.inputs.lifetime.partners(): Time trend in numbers of lifetime partners

  • ha.inputs.partner.age(): Partner change rates by age in the last year of projection

  • ha.inputs.partner.age.par(): Parameters describing relative rates of partner change by age

  • ha.inputs.mixing.age(): Mixing preferences by age

Details

  • ha.inputs.partner.age.par Returns the peak and median in relative rates of partner change by age after sexual debut. Relative rates of partner change at age a are calculated as dlnorm(a+0.5-debut, logmu, logsd) where logmu = median-debut and logsd=sqrt(logmu - ln(peak - debut))

  • ha.inputs.mixing.age Returns mixing preferences of females by male age. In wide format, rows correspond to male age, columns to female age.


rlglaubius/SpectrumUtils documentation built on Dec. 20, 2024, 7:31 a.m.