R/create_phe_table_from_plink_bin2_filenames.R

In richelbilderbeek/plinkr: Interface to PLINK

#' Create a single-phenotype table from a table
#' from the PLINK2 binary files.
#'
#' Create a single-phenotype table from a table
#' from the PLINK2 binary files.
#'
#' The individuals' family and within-family ID's are copied.
#' The \code{case_control_code} is copied as well, but
#' renamed to \code{trait} and divided by then.
#' In this way, PLINK treats the phenotype table as having quantitative
#' traits.
#' @inheritParams default_params_doc
#' @return a single-phenotype \link[tibble]{tibble}, with columns:
#'
#' * \code{FID} the family ID
#' * \code{IID} the within-family ID
#' * \code{P1} the phenotype
#'
#' The column names match the PLINK names, see
#' \url{https://www.cog-genomics.org/plink/1.9/input#pheno}
#' @author Richèl J.C. Bilderbeek
#' @export
create_phe_table_from_plink_bin2_filenames <- function(plink2_bin_filenames) { # nolint indeed a long function name
  plinkr::check_plink2_bin_filenames(plink2_bin_filenames)
  stop("TODO")
}