design_incidence: Describe the stratification to use for incidence computation...

View source: R/incidence_design.R

design_incidenceR Documentation

Describe the stratification to use for incidence computation (parameter design)

Description

Create a structure usable by incidence computation functions. The returned structure embed all data & metadata about stratification Only handle strata on age and geo level for instance By convention age group column will be names "age.cat"

Usage

design_incidence(
  age.categories,
  year.pop,
  geo,
  geo_column = NULL,
  geo_area = NULL,
  use.gender = FALSE,
  ...
)

Arguments

age.categories

list of breaks

year.pop

year of the population to fetch

geo

geographic level id (see geography & geo.levels in platform config.). could be character or structure return by geo_level function

geo_column

name of the geographic column (value return by strata.call), geo_level's column name by default

geo_area

id of geographic area to keep at the geographic level

use.gender

use gender as strata

...

other parameters to include in the design

Value

design.incidence object


cturbelin/ifnBase documentation built on Nov. 5, 2023, 12:54 p.m.