R/data_documentation.R

#' Pairwise haplotype frequencies for 7 HLA loci
#'
#' HLA haplotype frequencies for 21 pairs of HLA loci in a set of 300 controls
#' from a study of myopericarditis incidence following smallpox vaccination. 
#'
#'
#'
#' @format A data frame with 3063 observations on the following 5 variables.
#'  \describe{
#' \item{\code{haplo.freq}}{a numeric vector}
#' \item{\code{locus1}}{a character vector}
#' \item{\code{locus2}}{a character vector}
#' \item{\code{allele1}}{a character vector}
#' \item{\code{allele2}}{a character vector}
#' }
#' 
#' @name hla.freqs
#' @docType data
#' @source Wilson, C., 2010 Identifying polymorphisms associated with risk for the development of myopericarditis following smallpox vaccine. The Immunology Database and Analysis Portal (ImmPort), Study #26.
#' 
#' 
#' @references https://immport.niaid.nih.gov/immportWeb/clinical/study/displayStudyDetails.do?itemList=SDY26
#' 
#' 
#' @keywords data
#' @usage data(hla.freqs)
#' 
NULL


#' Pairwise haplotype frequencies for Northern Ireland population
#'
#' HLA haplotype frequencies for 6 pairs of HLA loci from Williams et al. 2004 for 1000 individuals from the Northern 
#' Ireland population.
#'
#' @details HLA-A, - B, - C, and -DRB1 loci
#'
#' @format A data frame with 1317 observations on the following 5 variables. 
#'   \describe{
#'     \item{\code{locus1}}{a character vector}
#'     \item{\code{locus2}}{a character vector}
#'     \item{\code{allele1}}{a character vector}
#'     \item{\code{allele2}}{a character vector}
#'     \item{\code{haplo.freq}}{a numeric vector}
#'   }
#' 
#' @name NIreland.freqs
#' @docType data
#' @source Williams F, Meenagh A, Single R, McNally M, Kelly P, Nelson MP, Meyer D, Lancaster A, Thomson G, and Middleton D. High resolution HLA-DRB1 identification of a Caucasian population. Human Immunology, 2004; 65(1): 66-77
#' 
#' 
#' @references http://www.ncbi.nlm.nih.gov/pubmed/14700598
#' 
#' 
#' @keywords data
#' @usage data(NIreland.freqs)
#' 
#' 
NULL
rsingle/LDtools documentation built on May 28, 2019, 3:32 a.m.