Get whether object is population attributable fraction or potential impact fraction

Returns whether a pif_class object was specified by the creator as population attributable fraction or potential impact fraction

Usage

get_fraction_type(object)

Arguments

object

A pif_class object

Examples

#Example 1
data(ensanut)
options(survey.lonely.psu = "adjust")
design <- survey::svydesign(data = ensanut, ids = ~1, weights = ~weight, strata = ~strata)
rr <- function(X, theta) {
  exp(-2 +
    theta[1] * X[, "age"] + theta[2] * X[, "systolic_blood_pressure"] / 100)
}
cft <- function(X) {
  X[, "systolic_blood_pressure"] <- X[, "systolic_blood_pressure"] - 5
  return(X)
}
pifsim <- pif(design,
  theta = log(c(1.05, 1.38)), rr, cft,
  additional_theta_arguments = c(0.01, 0.03), n_bootstrap_samples = 10,
)
get_fraction_type(pifsim)
#> [1] "Potential Impact Fraction (PIF)"