R/snpEnrichment-package.R

In mcanouil/snpEnrichment: SNPs Enrichment Analysis With Sampling

#' ~ Overview: SNPs Enrichment Analysis With Sampling ~
#'
#' @details
#'   Implements classes and methods for large-scale SNP enrichment analysis
#'   (*e.g.*, SNPs associated with genes expression in a GWAS signal).
#'
#' @note Internal data management in [snpEnrichment] use RefSNP (rs) IDs.
#'
#' @seealso
#' + Overview: [snpEnrichment]
#' + Classes: [Enrichment-class] [Chromosome-class]
#' + Methods:
#'     - [enrichment]
#'     - [chromosome]
#'     - [getEnrichSNP]
#'     - [plot]
#'     - [reSample]
#'     - [reset]
#' + Functions:
#'     - [initFiles]
#'     - [writeLD]
#'     - [excludeSNP]
#'     - [readEnrichment]
#'     - [compareEnrichment]
#'
#' @docType package
#' @name snpEnrichment
#'
"_PACKAGE"