create_test_assoc_params: Create testing parameters for the assoc function

View source: R/create_test_assoc_params.R

create_test_assoc_paramsR Documentation

Create testing parameters for the assoc function

Description

Create parameters (as created by create_assoc_params) to detect associations with quantitative traits (using assoc) used for testing.

Usage

create_test_assoc_params(confidence_interval = 0.95, maf = get_lowest_maf())

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

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).

Note

This function is named after the --assoc PLINK flag.

Author(s)

Richèl J.C. Bilderbeek


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