check_plink_bin_data: Check if the 'PLINK' bin data is valid.

In richelbilderbeek/plinkr: Interface to PLINK

Check if the PLINK bin data is valid.

Description

Check if the PLINK bin data is valid. Will stop if not.

Usage

check_plink_bin_data(plink_bin_data)

Arguments

plink_bin_data

the in-memory binary data for PLINK to work on, as created by create_plink_bin_data.

Details

Valid PLINK binary data has the following properties:

• The bed_table must be valid, as checked by check_bed_table

• The bim_table must be valid, as checked by check_bim_table

• The fam_table must be valid, as checked by check_fam_table

• The number of SNVs must match, as checked by check_equal_number_of_snvs

• The column names of the bed_table must match the ids in the fam_table

Value

nothing

Author(s)

Richèl J.C. Bilderbeek

See Also

plinkr has the following functions to check if in-memory data is valid:

• PLINK text data: use check_plink_text_data

• PLINK binary data: use check_plink_bin_data

• PLINK2 binary data: use check_plink2_bin_data

• any PLINK/PLINK2 data: use check_data

• quantitative trait analysis data: use check_assoc_qt_data

Examples

plink_bin_data <- create_test_plink_bin_data()
check_plink_bin_data(plink_bin_data)

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