Configure a relative risk

Creates a configuration list for a relative risk relationship between a risk factor and disease.

Usage

configure_relative_risk(index, from, to, relative_risk_filename)

Arguments

index

A character string which specifies the unique identifier for this relative risk relationship.

from

A character string which specifies the source (usually a risk factor).

to

A character string which specifies the target (usually a disease).

relative_risk_filename

A character string which specifies the path to the relative risk file.

Value

A list containing the relative risk configuration parameters.

Examples

configure_relative_risk(
  index = 0,
  from = "Smoking_cat3",
  to = "Lung_Cancer",
  relative_risk_filename = "RR_to_LungCa-Smoking_cat3"
)
#> $RRindex
#> [1] 0
#> 
#> $isRRfrom
#> [1] "Smoking_cat3"
#> 
#> $isRRto
#> [1] "Lung_Cancer"
#> 
#> $isRRFile
#> [1] "RR_to_LungCa-Smoking_cat3"
#>