ukb_gen_sqc_names: Sample QC column names

View source: R/genetics_qc.R

ukb_gen_sqc_namesR Documentation

Sample QC column names

Description

The UKB sample QC file has no header on it.

Usage

ukb_gen_sqc_names(data, col_names_only = FALSE)

Arguments

data

The UKB ukb_sqc_v2.txt data as dataframe. (Not necessary if column names only are required)

col_names_only

If TRUE returns a character vector of column names (data argument not required). Useful if you would like to supply as header when reading in your sample QC data. If FALSE (Default), returns the supplied dataframe with column names (Checks number of columns in supplied data. See Details.).

Details

From UKB Resource 531: There are currently 2 versions of this file (UKB ukb_sqc_v2.txt) in circulation. The newer version is described below and contains column headers on the first row. The older (deprecated) version lacks the column headers and has two additional Affymetrix internal values prefixing the columns listed below.

Value

A sample QC dataframe with column names, or a character vector of column names if col_names_only = TRUE.


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