R/cached_coding_genes.R

#' @title cached_coding_genes.RData
#' @description  Gene symbols for all human protein coding genes, cached for use in RITAN vignettes. The set of all human protein coding genes is the default "background" list. This data was generated by running the load_all_protein_coding_symbols() function from RITAN and saving the resulting vector of gene symbols. By default, functions in RITAN will download the most recent list. We encourage users to use the most appropriate background for their study. See our vignettes for additional discussion.
#' @format A \code{chr} vector of gene symbols for all protein coding genes
#' @source ftp://ftp.ebi.ac.uk/pub/databases/genenames/new/tsv/locus_groups/protein-coding_gene.txt
#' @return Chr vector of gene symbols
#' @author Michael T Zimmermann
#' @examples
#' print(str(cached_coding_genes))
"cached_coding_genes"
MTZimmer/RITANdata documentation built on May 8, 2019, 3:24 p.m.