Skip to contents

Extract mean of bootstrap simulations of potential impact fraction or population attributable fraction

mean.pif_class.Rd

Method for obtaining the arithmetic mean of bootstrap simulations of a pif_class object (i.e. the point-estimate of the potential impact fraction or population attributable fraction via the bootstrap).

Usage

# S3 method for pif_class
mean(x, ...)

Arguments

x

A pif_class object

...

additional arguments to pass to base::mean()

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,
)
mean(pifsim)
#>     counterfactual   relative_risk potential_impact_fraction
#> 1 Counterfactual_1 Relative_Risk_1                 0.0137558
#>   average_relative_risk average_counterfactual
#> 1              140698.1               138207.6