R/create_gcae_input_filenames.R

In richelbilderbeek/gcaer: Interface to GCAE

#' Create a `gcae_input_filenames`
#'
#' Create a `gcae_input_filenames`,
#' as can be checked by \link{check_gcae_input_filenames}
#' @inheritParams default_params_doc
#' @return a `gcae_input_filenames`,
#' as can be checked by \link{check_gcae_input_filenames}
#' @seealso
#' Use \link{get_gcae_input_filenames} to obtain
#' the `gcae_input_filenames` from a `gcae_setup`
#' (see \link{check_gcae_setup})
#' and `gcae_options`
#' (see \link{check_gcae_options}).
#'
#' Use \link{create_test_gcae_input_filenames} to create
#' a `gcae_input_filenames` to be used in testing.
#' @examples
#' create_gcae_input_filenames(
#'   bed_filename = get_gcaer_filename("gcae_input_files_1.bed"),
#'   bim_filename = get_gcaer_filename("gcae_input_files_1.bim"),
#'   fam_filename = get_gcaer_filename("gcae_input_files_1.fam"),
#'   phe_filename = get_gcaer_filename("gcae_input_files_1.phe"),
#'   labels_filename = get_gcaer_filename("gcae_input_files_1_labels.csv")
#' )
#' @author Richèl J.C. Bilderbeek
#' @export
create_gcae_input_filenames <- function(
  bed_filename,
  bim_filename,
  fam_filename,
  phe_filename,
  labels_filename
) {
  plinkr::check_base_input_filename(bed_filename)
  plinkr::check_base_input_filename(bim_filename)
  plinkr::check_base_input_filename(fam_filename)
  plinkr::check_base_input_filename(phe_filename)

  # labels_filename can be an empty string
  testthat::expect_equal(1, length(labels_filename))
  testthat::expect_true(is.character(labels_filename))

  list(
    bed_filename = bed_filename,
    bim_filename = bim_filename,
    fam_filename = fam_filename,
    phe_filename = phe_filename,
    labels_filename = labels_filename
  )
}