is_fam_table: Determine if a '.fam' table is valid.

In richelbilderbeek/plinkr: Interface to PLINK

Determine if a .fam table is valid.

Description

Determine if a .fam table is valid.

Usage

is_fam_table(fam_table, verbose = FALSE)

Arguments

fam_table	a tibble of the genetic mapping, with as many rows as SNPs. Each row contains: fam: the family ID id: the individual's ID pat: ID of father mat: ID of mother sex: the gender pheno: a phenotype Use get_test_fam_table to get a .fam table as used in testing. Use read_plink_fam_file to read a PLINK .fam file. Use check_fam_table to test if a .fam table is valid.
verbose	the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Value

TRUE if the table is a valid .fam table

Author(s)

Richèl J.C. Bilderbeek

See Also

use check_fam_table to check if a table is a valid .fam table (i.e. stop if it is not)

Examples

is_fam_table(get_test_fam_table())
is_fam_table(read_plink_fam_file(get_plinkr_filename("toy_v1_9.fam")))

is_fam_table("nonsense")

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