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

View source: R/is_pvar_table.R

is_pvar_tableR Documentation

Determine if a .pvar table is valid.

Description

Determine if a .pvar table is valid.

Usage

is_pvar_table(pvar_table, verbose = FALSE)

Arguments

pvar_table

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

  • CHROM: the chromosome

  • POS: the position on the chromosome

  • ID: the SNP ID

  • REF: the reference variant

  • ALT: the alternate variant

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_pvar_table to check if a table is a valid .pvar table (i.e. stop if it is not)

Examples

is_pvar_table(get_test_pvar_table())

is_pvar_table("nonsense")

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