get_protection_level: Protection level calculations

Description Usage Arguments Value

View source: R/protection.R

Description

Calculates covariate values corresponding to a particular protection level. Only accepts one covariate at a time, fixed values of all the others should be provided. The search engine is find_prot_titre_val.

Usage

1
2
3
4
5
6
7
8
get_protection_level(
  fit,
  var_name,
  newdata = NULL,
  lvl = 0.5,
  ci_level = 0.95,
  tol = 10^(-7)
)

Arguments

fit

Object returned by sclr.

var_name

Name of the covariate for which to find values corresponding to a protection level. This name should appear in the formula in the call to sclr which was used to generate fit.

newdata

A dataframe with all covariates except the one for which protection values should be calculated. If there is only one covariate, can be left as NULL (the default)

lvl

Protection level to find covariate values for. Default is 0.5 (50%)

ci_level

Confidence level for the calculated interval. Default is 0.95.

tol

Tolerance. The values will be found numerically, once the algorithm converges within tol of lvl it stops looking. Default is 10^(-7).

Value

A tibble. Will have the same variables as newdata with the addition of the var_name variable.


khvorov45/sclr documentation built on March 4, 2020, 7:17 p.m.