R/ClusterBurden.r

Defines functions ClusterBurden

Documented in ClusterBurden

#' ClusterBurden test for burden and position of rare-missense variants
#'
#' Combine p-values from BIN_test() and burden_test()
#'
#' @author Adam Waring - adam.waring@@msdtc.ox.ac.uk
#' @return Returns a single unnamed p-value of type num
#'
#' @param case_residues vector of case-variant amino acid residue positions
#' @param control_residues vector of control-variant amino acid residue positions
#' @param n1 number of carriers cases
#' @param n2 number of carriers controls
#' @param ss1 sample size cases
#' @param ss2 sample size controls
#'
#' @keywords RVAT, distribution, cluster, genetics, case-control, gene
#'
#' @details Perform ClusterBurden test
#'
#' @export


ClusterBurden = function(case_residues, control_residues, n1, n2, ss1, ss2){

  binpval = BIN_test(case_residues, control_residues)$p.value
  fpval = burden_test(n1=n1, n2=n2, ss1=ss1, ss2=ss2)$p
  combined_test(binpval, fpval)

}
adamwaring/POSBURDEN documentation built on Feb. 21, 2020, 11:21 a.m.