check_window_kb: Check if the window size (in kilobases) is valid. Check if...

In richelbilderbeek/plinkr: Interface to PLINK

Check if the window size (in kilobases) is valid. Check if the window size (in kilobases) is valid. Will stop if not

Description

Check if the window size (in kilobases) is valid. Check if the window size (in kilobases) is valid. Will stop if not

Usage

check_window_kb(window_kb)

Arguments

window_kb

the window (i.e. the amount of base pairs around a focal SNP) in kilobases, as checked by check_window_kb

Value

Nothing. Will stop if the window size (in kilobases) is invalid

Note

PLINK uses a CLI flag called --window that works with kilobases. To adhere to the PLINK interface, the word 'window' is used, yet with the unit added in the flag's name

Author(s)

Richèl J.C. Bilderbeek

See Also

the window size is used by:

• create_snp_window_selector: to select variants of a certain window around a SNP

Examples

check_window_kb(0.001) # 1 base pair
check_window_kb(1) # 1000 base pairs

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