R/data.R

#' Metadata and links to data
#'
#' Metadata for cell type-specific epigenomic bigWig files hosted
#'  on UCSC Genome Browser.
#' bigWig files contain the genomic ranges from each epigenomic assay,
#' as well as a Score column which describes the peaks of the aggregate reads.
#' @family NOTT2019
#' @source \url{https://doi.org/10.1126/science.aay0793}
#' @source
#' \code{
#' NOTT2019_bigwig_metadata <- data.table::data.table(
#'     readxl::read_excel(
#'         file.path(
#'             "~/Desktop/Fine_Mapping/echolocatoR/annotations",
#'             "NOTT2019/NOTT2019_snEpigenomics.xlsx"
#'         )
#'     )
#' )
#' usethis::use_data(NOTT2019_bigwig_metadata, overwrite = TRUE)
#' }
#' @usage data("NOTT2019_bigwig_metadata")
"NOTT2019_bigwig_metadata"


#' Example XGR query
#'
#' Example XGR query results from \pkg{XGR} via
#' \link[echoannot]{XGR_query} using the
#' "ENCODE_DNaseI_ClusteredV3_CellTypes" dataset.
#' @family XGR
#' @source
#' \code{
#' xgr_example <- echoannot::XGR_query(
#'     c("ENCODE_DNaseI_ClusteredV3_CellTypes"),
#'     dat = echodata::BST1)
#' }
#' usethis::use_data(xgr_example, overwrite = TRUE)
#' @usage data("xgr_example")
"xgr_example"


#' IMPACT files
#'
#' URLs to annotations/LD-scores generated by
#' \href{https://github.com/immunogenomics/IMPACT}{IMPACT} 
#' (Inference and Modeling of Phenotype-related ACtive Transcription),
#' @family IMPACT
#' @source
#' \code{
#' IMPACT_files <- downloadR::zenodo_list(token = token)[!endsWith(filename,
#'                                                      c(".zip",".tbi")),]
#' usethis::use_data(IMPACT_files, overwrite = TRUE)
#' }
#' @usage data("IMPACT_files")
"IMPACT_files"
 
RajLabMSSM/echoannot documentation built on Oct. 26, 2023, 2:41 p.m.