check_fam_table: Check if a '.fam' table is valid.

View source: R/check_fam_table.R

check_fam_tableR Documentation

Check if a .fam table is valid.

Description

Check if a .fam table is valid. Will stop if not

Usage

check_fam_table(fam_table)

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.

Value

Nothing. Will stop if the fam_table is invalid

Author(s)

Richèl J.C. Bilderbeek

Examples

check_fam_table(get_test_fam_table())
check_fam_table(read_plink_fam_file(get_plinkr_filename("toy_data.fam")))

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