ukb_gen_read_fam: Reads a PLINK format fam file

In kenhanscombe/ukbtools: Manipulate and Explore UK Biobank Data

Reads a PLINK format fam file

Description

This is wrapper for read_table that reads a basic PLINK fam file. For plink hard-called data, it may be useful to use the fam file ids as a filter for your phenotype and covariate data.

Usage

ukb_gen_read_fam(
  file,
  col.names = c("FID", "IID", "paternalID", "maternalID", "sex", "phenotype"),
  na.strings = "-9"
)

Arguments

file	A path to a fam file.
col.names	A character vector of column names. Default: c("FID", "IID", "paternalID", "maternalID", "sex", "phenotype")
na.strings	Character vector of strings to use for missing values. Default "-9". Set this option to character() to indicate no missing values.

See Also

ukb_gen_read_sample to read a sample file

kenhanscombe/ukbtools documentation built on Feb. 25, 2023, 8:37 a.m.