Skip to contents

Signal Pre-Screen Settings

Source: R/fineMappingPipeline.R
SignalScreenParam.Rd

Whether to skip a block before fitting it, and on which metric. Shared by fineMappingPipeline and colocboostPipeline.

Usage

SignalScreenParam(pip = NULL, absZ = NULL, bf = NULL, logBf = NULL)

Arguments

pip

Posterior-inclusion-probability cutoff. A negative value uses the adaptive 3 / nVariants threshold.

absZ

Cutoff on the maximum absolute z-score.

bf

Cutoff on the maximum per-variant Bayes factor.

logBf

Cutoff on the maximum per-variant log Bayes factor.

Value

A SignalScreenParam object, a MethodParam.

One metric at a time

The four metrics are mutually exclusive and the constructor enforces it, so a conflicting pair fails where it is written rather than part-way into a pipeline run. Leave them all unset (the default) to screen nothing.

Examples

SignalScreenParam(absZ = 5)
#> <SignalScreenParam>
#>   absZ                     5
#>   unset: pip, bf, logBf