check_confidence_interval: Check if the 'confidence_interval' is valid. Check if the...

In richelbilderbeek/plinkr: Interface to PLINK

Check if the confidence_interval is valid. Check if the confidence_interval is valid, which is when:

Description

• its length is 1

• its only element is either

  • NA

  • a number between 0.0 and 1.0 (i.e. excluding 0.0 and 1.0)

Usage

check_confidence_interval(confidence_interval)

Arguments

confidence_interval

confidence interval, a value between (and excluding both) 0.0 and 1.0. The confidence interval helps assess the certainty of an estimation: you can be 99 percent sure a value is within the range of the 0.99 confidence interval The confidence_interval is only used by PLINK2. For PLINK, its value is ignored

Details

Will stop if not

Value

Nothing. Will stop if the input is not a number between 0.0 and 1.0

Author(s)

Richèl J.C. Bilderbeek

Examples

check_confidence_interval(NA)
check_confidence_interval(0.01)
check_confidence_interval(0.95)
check_confidence_interval(0.99)

richelbilderbeek/plinkr documentation built on March 25, 2024, 3:18 p.m.