loadFamFile: Load '.fam' file

In KLINK: Kinship Analysis with Linked Markers

Load .fam file

Description

Load .fam file

Usage

loadFamFile(path, fallbackModel = "equal", withParams = FALSE)

Arguments

path	The path to a .fam file.
fallbackModel	The name of a mutation model; passed on to pedFamilias::readFam().
withParams	A logical indicating if the Familias parameters should be included in the output. (See pedFamilias::readFam().)

Value

If withParams = FALSE, a list of two pedigree hypotheses in the form of ped objects. If withParams = TRUE, a list with components peds and params.

Examples

fam = system.file("extdata/halfsib-test.fam", package = "KLINK")
peds = loadFamFile(fam)
pedtools::plotPedList(peds)

loadFamFile(fam, withParams = TRUE)$params

KLINK documentation built on Aug. 3, 2026, 5:07 p.m.