is_bed_table: Determine if a '.bed' table is valid.

In richelbilderbeek/plinkr: Interface to PLINK

Determine if a .bed table is valid.

Description

Determine if a .bed table is valid.

Usage

is_bed_table(bed_table, verbose = FALSE)

Arguments

bed_table

a table that maps the SNPs to the individuals, of which the column names are the names of the individuals, the row names are the names of the SNPs, and the values are the SNP variant. Use get_test_bed_table to get a .bed table as used in testing. Use read_plink_bed_file to read a PLINK .bed file. Use check_bed_table to test if a .bed table is valid. See also the bed file format reference at https://www.cog-genomics.org/plink2/formats#bed

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

Author(s)

Richèl J.C. Bilderbeek

See Also

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

Examples

is_bed_table(get_test_bed_table())
is_bed_table("nonsense")

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