R/helper.R

In fbzwsqualitasag/qzwslrm: Validation of Predicted Breeding Values Using the LR-Method

## -- Path To Example Files ----------------------------------------------------

#' Return Path to Example Data
#'
#' @description
#' Return path to example solani result file containing EBV from either whole
#' or partial data.
#'
#' @param ps_data_type type of data set can be either 'partial' or 'whole'
#'
#' @return path to example data
#' @export qzwslrm_example_solani
#'
#' @examples
#' ed_path <- qzwslrm_example_solani('partial')
qzwslrm_example_solani <- function(ps_data_type){
  s_example_data_result <- NULL
  if (ps_data_type == 'partial'){
    s_example_data_result <- system.file("extdata", "mix99", "partial_data", "Solani", package = "qzwslrm")
  } else if (ps_data_type == 'whole'){
    s_example_data_result <- system.file("extdata", "mix99", "whole_data", "Solani", package = "qzwslrm")
  } else {
    stop(" *** ERROR: Unknown type of data: ", ps_data_type, " - either use [partial/whole]")
  }
  return(s_example_data_result)
}

## -- Input Example Files ------------------------------------------------------

#' Path to Input Example Files
#'
#' @description
#' The path to the input files with different formats contained in this package
#' can be obtained
#'
#' @param ps_data_format format of input file
#'
#' @return path to input file
#' @export qzwslrm_example_input
#'
#' @examples
#' sexdf_csv <- qzwslrm_example_input("csv")
qzwslrm_example_input <- function(ps_data_format){
  s_example_input_result <- NULL
  if (ps_data_format == 'csv'){
    s_example_input_result <- system.file("extdata", "ebvinput", "ebv_input.csv", package = "qzwslrm")
  } else if (ps_data_format == 'csv2'){
    s_example_input_result <- system.file("extdata", "ebvinput", "ebv_input.csv2", package = "qzwslrm")
  } else if (ps_data_format == 'delim'){
    s_example_input_result <- system.file("extdata", "ebvinput", "ebv_input.txt", package = "qzwslrm")
  } else {
    stop(" *** ERROR: Unknown input data format: ", ps_data_format, " - either use [csv/csv2/delim]")
  }
  return(s_example_input_result)
}