check_sample_ids: Check if a 'sample_ids' is valid.

In richelbilderbeek/plinkr: Interface to PLINK

Check if a sample_ids is valid.

Description

Check if a sample_ids is valid. Will stop if not

Usage

check_sample_ids(sample_ids)

Arguments

sample_ids

sample IDs, which is a tibble with two columns: the first column holds the family ID (called fid or FID by PLINK/PLINK2), the second column holds the within-family ID (called iid or IID by PLINK/PLINK2), as can be checked by check_sample_ids

Value

Nothing. Will stop if the sample_ids is invalid

Author(s)

Richèl J.C. Bilderbeek

Examples

# For PLINK, a .phe table contains the sample IDs
phe_table <- get_test_phe_table()
sample_ids <- phe_table[, 1:2]
check_sample_ids(sample_ids)

# For PLINK2, a .psam table contains the sample IDs
psam_table <- get_test_psam_table()
sample_ids <- psam_table[, 1:2]
check_sample_ids(sample_ids)

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