check_ld_window_r2: Check if the 'ld_window_r2' is valid. Check if the...

View source: R/check_ld_window_r2.R

check_ld_window_r2R Documentation

Check if the ld_window_r2 is valid. Check if the ld_window_r2 is valid, which is one number in range zero (including zero) to one (including one)

Description

Will stop if not

Usage

check_ld_window_r2(ld_window_r2)

Arguments

ld_window_r2

the minimal squared correlation coefficient (also known as r^2) between markers. This parameter is named after the --ld_window_r2 flag, as documented at https://www.cog-genomics.org/plink/1.9/ld.

Value

Nothing. Will stop if the input is not one number in range zero to one

Author(s)

Richèl J.C. Bilderbeek

Examples

check_ld_window_r2(0.0)
check_ld_window_r2(0.2)
check_ld_window_r2(1.0)

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