is_plink_bin_data: Determine if the 'plink_bin_data' is indeed 'PLINK' bin data

In richelbilderbeek/plinkr: Interface to PLINK

Determine if the plink_bin_data is indeed PLINK bin data

Description

Determine if the plink_bin_data is indeed PLINK bin data

Usage

is_plink_bin_data(plink_bin_data, verbose = FALSE)

Arguments

plink_bin_data	the in-memory binary data for PLINK to work on, as created by create_plink_bin_data.
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 plink_bin_data is indeed PLINK binary data

Author(s)

Richèl J.C. Bilderbeek

See Also

plinkr has multiple functions to test if a type of data is valid:

• PLINK text data: use is_plink_text_data

• PLINK binary data: use is_plink_bin_data

• PLINK2 binary data: use is_plink2_bin_data

• any type of PLINK/PLINK2 data: use is_data

• associative trait analysis data: use is_assoc_qt_data

Examples

plink_bin_data <- create_plink_bin_data(
  bed_table = get_test_bed_table(),
  bim_table = get_test_bim_table(),
  fam_table = get_test_fam_table()
)
is_plink_bin_data(plink_bin_data)

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