R/data.R

In ehfhcrc/UpdateAnno: Update Annotation to Latest Symbols using org.Hs.eq.db

#' Original HIPC BTM list
#'
#' A dataset containing the geneSet pathways and geneIds for
#' a BTM file with the original date as October 08, 2013 generated
#' by the HIPC collaborators and stored in the HIPC google drive.
#'
#' @format A list of lists with charactar vector elements
#' \describe{
#'   \item{names}{geneSet pathway names}
#'   \item{elements}{character vector of gene symbols}
#'   ...
#' }
"orig_btm_list"

#' Updated HIPC BTM list
#'
#' A dataset containing the geneSet pathways and geneIds for
#' a BTM file that is updated using the most recent version of
#' the org.Hs.eq.db package each time the UpdateAnno package is
#' re-installed with build_vignette = TRUE.
#'
#' @format A list of lists with charactar vector elements
#' \describe{
#'   \item{names}{geneSet pathway names}
#'   \item{elements}{character vector of gene symbols}
#'   ...
#' }
"updated_btm_list"

#' Updated HIPC BTM data frame
#'
#' A dataset containing the geneSet pathways and geneIds for
#' a BTM file with the original date as October 08, 2013 generated
#' by the HIPC collaborators and stored in the HIPC google drive.
#'
#' @format A dataframe with pathways and geneIds
#' \describe{
#'   \item{pathway}{geneSet pathway names}
#'   \item{SYMBOL}{updated gene symbols}
#'   ...
#' }
"updated_btm_df"

#' @name msigdb_immunologic_signatures
#' @title Immunologic signatures
#'
#' @description
#' Gene sets that represent cell states and perturbations within the immune
#' system. The signatures were generated by manual curation of published studies
#' in human and mouse immunology. For each study, pairwise comparisons of
#' relevant classes were made and genes ranked by mutual information. Gene sets
#' correspond to top or bottom genes (FDR < 0.25 or maximum of 200 genes) for
#' each comparison. This resource is generated as part of the Human Immunology
#' Project Consortium (HIPC; http://www.immuneprofiling.org/). NOTE: Gene Symbols
#' are updated by the upDateAnnoGMT.Rmd when it is run.  Original is kept as
#' orig_msigdb.
#'
#' @usage data(msigdb_immunologic_signatures)
#' @format A \code{list} of \code{character} of length 1910, with one element
#' per module.
#'
#' @references http://www.broadinstitute.org/gsea/msigdb/genesets.jsp?collection=C7
"msigdb_immunologic_signatures"

#' @name emory_blood_transcript_modules
#' @title Blood transcriptome modules
#' @description NOTE: Gene Symbols are updated by the upDateAnnoGMT.Rmd when it is run.
#' Original is kept as orig_emory.
#'
#' @usage data(emory_blood_transcript_modules)
#' @format A \code{list} of \code{character} of length 346, with one element per
#' module
#'
#' @references
#'  http://www.immuneprofiling.org/meni/meni-paper/btm-landing.gsp
#'  http://www.nature.com/ni/journal/v15/n2/full/ni.2789.html
"emory_blood_transcript_modules"

#' @name chaussabel_modules
#' @title Modules from Chaussabel (2008)
#'
#' @description
#' Repertoire of co-clustering genes. NOTE: Gene Symbols are updated by the upDateAnnoGMT.Rmd
#' when it is run.  Original is kept as orig_chaussabel.
#'
#' @usage data(chaussabel_modules)
#' @format A \code{list} of \code{character} of length 260, with one element per
#' module.
#'
#' @references
#'  http://www.biir.net/public_wikis/module_annotation/G2_Trial_8_Modules
#'  http://www.nature.com/nri/journal/v14/n4/full/nri3642.html
"chaussabel_modules"

#' @name orig_msigdb
#' @title Immunologic signatures
#'
#' @description
#' Gene sets that represent cell states and perturbations within the immune
#' system. The signatures were generated by manual curation of published studies
#' in human and mouse immunology. For each study, pairwise comparisons of
#' relevant classes were made and genes ranked by mutual information. Gene sets
#' correspond to top or bottom genes (FDR < 0.25 or maximum of 200 genes) for
#' each comparison. This resource is generated as part of the Human Immunology
#' Project Consortium (HIPC; http://www.immuneprofiling.org/).
#'
#' @usage data(orig_msigdb)
#' @format A \code{list} of \code{character} of length 1910, with one element
#' per module.
#'
#' @references http://www.broadinstitute.org/gsea/msigdb/genesets.jsp?collection=C7
"orig_msigdb"

#' @name orig_emory
#' @title Blood transcriptome modules
#'
#' @usage data(orig_emory)
#' @format A \code{list} of \code{character} of length 346, with one element per
#' module
#'
#' @references
#'  http://www.immuneprofiling.org/meni/meni-paper/btm-landing.gsp
#'  http://www.nature.com/ni/journal/v15/n2/full/ni.2789.html
"orig_emory"

#' @name orig_chaussabel
#' @title Modules from Chaussabel (2008)
#'
#' @description
#' Repertoire of co-clustering genes.
#'
#' @usage data(orig_chaussabel)
#' @format A \code{list} of \code{character} of length 260, with one element per
#' module.
#'
#' @references
#'  http://www.biir.net/public_wikis/module_annotation/G2_Trial_8_Modules
#'  http://www.nature.com/nri/journal/v14/n4/full/nri3642.html
"orig_chaussabel"

#' org.Hs.eg.db packageVersion
#'
#' packageVersion of org.Hs.eg.db used to update gene symbols. Pushed
#' to microarray.FeatureAnnotationSet.
#'
#' @format string
#' \describe{
#'   \item{value}{packageVersion of org.Hs.eg.db used in updates}
#'   ...
#' }
"orgHsEgDb_version"