check_gcae_input_data: Check if the 'gcae_input_data' is valid, i.e. can be run by...

View source: R/check_gcae_input_data.R

check_gcae_input_dataR Documentation

Check if the gcae_input_data is valid, i.e. can be run by GCAE

Description

Check if the gcae_input_data is valid, i.e. can be run by GCAE. Will stop if not.

Usage

check_gcae_input_data(gcae_input_data)

Arguments

gcae_input_data

in-memory data that can be used as input for GCAE. Use linkread_gcae_input_files to read it from files, use check_gcae_input_data to check it for validity.

Value

Nothing. Will stop if gcae_input_data is invalid.

Author(s)

Richèl J.C. Bilderbeek

See Also

Related checking functions:

  • Use check_gcae_input_data to check the in-memory GCAE input data extensively

  • Use check_gcae_input_data_data_type to check the data type of the in-memory GCAE input data

  • Use check_gcae_input_files to check the files to be used by GCAE as input, i.e. GCAE can run these

  • Use check_gcae_input_filenames to check the filenames (and not the files' content) to be GCAE input files

Functions related to gcae_input_data:

  • Use summarise_gcae_input_data to summarise the GCAE input data

Examples

if (plinkr::is_plink_installed()) {
  gcae_input_filenames <- create_gcae_input_files_1(
    base_input_filename = get_gcaer_tempfilename()
  )
  gcae_input_data <- read_gcae_input_files(gcae_input_filenames)
  check_gcae_input_data(gcae_input_data)

  # Clean up
  file.remove(as.character(unlist(gcae_input_filenames)))
}

richelbilderbeek/gcaer documentation built on March 25, 2024, 3:08 p.m.