get_param_info: Get information about the bias parameters

In louisahsmith/simpleSens: What the Package Does (One Line, Title Case)

Description

Function used to return the information about the parameters that define a given combination of biases.

Usage

get_param_info(biases)

Arguments

biases

A list of biases to include. May include any or all of confounding(), selection(), and misclassification(), and any of the options described in the documentation for those functions.

Value

Returns a dataframe with information about the parameters defining the biases. Columns include the name of the parameter used in the package messages, the corresponding name of the argument used in the calculate_bound() function, the type of bias the parameter corresponds to, and a simple interpretation of that parameter. Useful for getting information about the required arguments of calculate_bound() or information on interpreting the output of calculate_evalue().

Examples

get_param_info(biases = list(confounding()))

get_param_info(biases = list(selection("selected"),
                             misclassification("outcome")))

get_param_info(biases =
               list(selection("general", "S = U"),
                    misclassification("exposure",
                            outcome_rare = TRUE,
                            exposure_rare = TRUE),
                    confounding()))

louisahsmith/simpleSens documentation built on March 19, 2020, 12:07 a.m.