check_maf: Check if the 'maf' is valid. Check if the 'maf', an...

In richelbilderbeek/plinkr: Interface to PLINK

Check if the maf is valid. Check if the maf, an abbreviation of 'Minor Allele Frequency' is valid, which is when it is a number between 0.0 and 0.5 (i.e. excluding 0.0 and 0.5).

Description

Will stop if not

Usage

check_maf(maf)

Arguments

maf

minor allele frequency threshold. Alleles that have a frequency lower than the MAF are excluded from the PLINK analysis. maf must be a value between zero and 0.5 (i.e. excluding zero and excluding 0.5). By default, maf is set to the lowest representable non-zero floating-point value, as obtained by get_lowest_maf The parameter name maf is named after the PLINK --maf flag. This was chosen over more specific names such as min_allele_frequency).

Value

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

Author(s)

Richèl J.C. Bilderbeek

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