summarise_gcae_input_files: Summarise the GCAE input files

In richelbilderbeek/gcaer: Interface to GCAE

Summarise the GCAE input files

Description

Summarise the GCAE input files

Usage

summarise_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

This function will show the summary using message. A list with all the elements shown is returned as well

Note

this function is named after the base R summarise function

Author(s)

Richèl J.C. Bilderbeek

Examples

gcae_input_filenames <- create_test_gcae_input_filenames()
summarise_gcae_input_files(gcae_input_filenames)

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