Fst: Fst (or rho_ST) estimation

View source: R/Genepop.R

FstR Documentation

Fst (or rho_ST) estimation

Description

Evaluates Fst or related measures based on allele sizes, for all populations of for all pairs of populations. See this section of the Genepop executable documentation for more information on the statistical methods.

Usage

Fst(
  inputFile,
  sizes = FALSE,
  pairs = FALSE,
  outputFile = "",
  dataType = "Diploid",
  verbose = interactive()
)

Arguments

inputFile

The path of the input file, in Genepop format

sizes

logical: whether to estimate allele-size based statistics, or identity-based Fst

pairs

whether to estimate differentiation between all pairs of populations, or to compute a global estimate for all populations

outputFile

character: The path of the output file

dataType

character: The haploid and diploid data

verbose

logical: whether to print some information

Value

The path of the output file is returned invisibly.

Examples

locinfile <- genepopExample('sample.txt')
Fst(locinfile, outputFile= 'sample.txt.DIV')
if ( ! interactive()) clean_workdir(otherfiles='sample.txt')

genepop documentation built on Jan. 22, 2023, 1:07 a.m.