check_gcae_input_files: Check if the GenoCAE input files are valid.

In richelbilderbeek/gcaer: Interface to GCAE

Check if the GenoCAE input files are valid.

Description

Check if the GenoCAE input files are valid. Will stop if not

Usage

check_gcae_input_files(gcae_input_filenames, verbose = FALSE)

Arguments

gcae_input_filenames

the GCAE input filenames, in the form of a list with the following elements: bed_filename: path to a .bed file, as can be read by read_plink_bed_file bim_filename: path to a .bim file, as can be read by read_plink_bim_file fam_filename: path to a .fam file, as can be read by read_plink_fam_file phe_filename: path to a .phe file, as can be read by read_plink_phe_file labels_filename: path to a .csv file as can be read by read_labels_file

verbose

the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Value

Nothing. Will stop if the GenoCAE input files are invalid.

Author(s)

Richèl J.C. Bilderbeek

See Also

• 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

• Use summarise_gcae_input_data to summarise the data

Examples

if (plinkr::is_plink_installed()) {
  # Create the files
  gcae_input_filenames <- create_gcae_input_files_1(
    base_input_filename = gcaer::get_gcaer_tempfilename()
  )

  # Check the files
  check_gcae_input_files(gcae_input_filenames)

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

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