is_psam_table: Determine if a '.pvar' table is valid.

View source: R/is_psam_table.R

is_psam_tableR Documentation

Determine if a .pvar table is valid.

Description

Determine if a .pvar table is valid.

Usage

is_psam_table(psam_table, verbose = FALSE)

Arguments

psam_table

a tibble with as much rows as individuals. It has the following columns:

  • FID: the family ID

  • IID: the within-family ID

  • SEX: the sex

  • PHENO1: a phenotypic value

The uppercase column names are those as used by PLINK2.

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 .pvar table

Author(s)

Richèl J.C. Bilderbeek

See Also

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

Examples

is_psam_table(get_test_psam_table())

is_psam_table("nonsense")

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