check_data: Check if the data is valid

View source: R/check_data.R

check_dataR Documentation

Check if the data is valid

Description

Check if the data is valid. The data can be in PLINK text, PLINK binary or PLINK2 binary format. Will stop if the data is not in any of these formats

Usage

check_data(data)

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

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

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

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