theoretical_coi: Theoretical COI

View source: R/theoretical_coi.R

theoretical_coiR Documentation

Theoretical COI

Description

\loadmathjax

Generate the theoretical relationship between the WSMAF (\mjseqn\bfw), the PLMAF (\mjseqn\bfp), and the COI (\mjseqnk).

Usage

theoretical_coi(
  coi_range,
  plmaf = seq(0, 0.5, length.out = 101),
  coi_method = c("variant", "frequency")
)

Arguments

coi_range

The COIs for which the relationship will be generated.

plmaf

The population-level minor allele frequency over which the relationship will be generated.

coi_method

The method we will use to generate the theoretical relationship. The method is either "variant" or "frequency". The default value is "variant".

Value

A tibble() containing the generated values. Each column is named with the COI used. The last column of the tibble contains the PLMAF.

Examples

theoretical_coi(1:5)
theoretical_coi(1:5, coi_method = "frequency")

bailey-lab/coiaf documentation built on April 26, 2023, 6:32 p.m.