is_data: Determine if the 'data' is indeed 'PLINK' bin data

In richelbilderbeek/plinkr: Interface to PLINK

Determine if the data is indeed PLINK bin data

Description

Determine if the data is indeed PLINK bin data

Usage

is_data(data, verbose = FALSE)

Arguments

data

the data source, which can be: PLINK text data, as created by create_plink_text_data. PLINK binary data, as created by create_plink_bin_data. PLINK2 binary data, as created by create_plink2_bin_data. PLINK text filenames, as created by create_plink_text_filenames. PLINK binary filenames, as created by create_plink_bin_filenames. PLINK2 binary filenames, as created by create_plink2_bin_filenames. data to be used by assoc, as created by create_assoc_data data to be used by assoc_qt, as created by create_assoc_qt_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 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

is_data(data = create_test_plink_text_data())
is_data(data = create_test_plink_bin_data())
is_data(data = create_test_plink2_bin_data())
is_data(data = create_test_plink_text_filenames())
is_data(data = create_test_plink_bin_filenames())
is_data(data = create_test_plink2_bin_filenames())

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