is_bim_table: Determine if a '.bim' table is valid.

View source: R/is_bim_table.R

is_bim_tableR Documentation

Determine if a .bim table is valid.

Description

Determine if a .bim table is valid.

Usage

is_bim_table(bim_table, verbose = FALSE)

Arguments

bim_table

a tibble of the genetic mapping, with as many rows as SNPs.

Each row contains:

  • chr: the chromosome number

  • id: the SNP ID

  • posg: the position

  • pos: the position

  • ref: something

  • alt: something

Use get_test_bim_table to get a .bim table as used in testing. Use read_plink_bim_file to read a PLINK .bim file. Use check_bim_table to test if a .bim table is valid.

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

Author(s)

Richèl J.C. Bilderbeek

See Also

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

Examples

is_bim_table(get_test_bim_table())
is_bim_table("nonsense")

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