R/literature.R

Defines functions literature_gwas

Documented in literature_gwas

#' Literature evidence regarding a GWAS trait
#'
#' [`GET /literature/gwas`](https://docs.epigraphdb.org/api/api-endpoints/#get-literaturegwas)
#'
#' @param trait A trait name
#' @param semmed_predicate Either NULL which returns entries from
#' all predicates, or a SemMed predicate e.g. "DIAGNOSES" or "ASSOCIATED_WITH"
#' @inheritParams mr
#' @return Data from `GET /literature/gwas`
#'
#' @examples
#' \dontrun{
#' literature_gwas(trait = "Body mass index")
#' }
#' @export
literature_gwas <- function(trait, semmed_predicate = NULL,
                            mode = c("table", "raw")) {
  mode <- match.arg(mode)
  response <- query_epigraphdb(
    route = "/literature/gwas",
    params = list(
      trait = trait,
      semmed_predicate = semmed_predicate
    ),
    mode = mode
  )
  response
}
MRCIEU/epigraphdb-r documentation built on Aug. 29, 2022, 4:05 a.m.