R/get_significant_single_tissue_isqtls.R

In gtexr: Query the GTEx Portal API

#' Get Significant Single Tissue Isqtls
#'
#' @description Retrieve Interaction sQTL Data.
#'
#' - This service retrieves cell type interaction
#'   sQTLs (isQTLs), from a specified dataset.
#' - Results may be filtered by tissue
#' - By default, the service queries the latest GTEx release.
#'
#' The retrieved data is split into pages with `items_per_page` entries per page
#'
#' [GTEx Portal API documentation](https://gtexportal.org/api/v2/redoc#tag/Static-Association-Endpoints/operation/get_significant_single_tissue_isqtls_api_v2_association_singleTissueISqtl_get).
#'
#' @inheritParams gtexr_arguments
#' @returns A tibble. Or a list if `.return_raw = TRUE`.
#' @export
#' @family Static Association Endpoints
#'
#' @examplesIf identical(Sys.getenv("IN_PKGDOWN"), "true")
#' get_significant_single_tissue_isqtls(gencodeIds = c(
#'   "ENSG00000065613.9",
#'   "ENSG00000203782.5"
#' ))
get_significant_single_tissue_isqtls <- function(gencodeIds,
                                                 variantIds = NULL,
                                                 tissueSiteDetailIds = NULL,
                                                 datasetId = "gtex_v8",
                                                 page = 0,
                                                 itemsPerPage = getOption("gtexr.itemsPerPage"),
                                                 .verbose = getOption("gtexr.verbose"),
                                                 .return_raw = FALSE) {
  gtex_query(endpoint = "association/singleTissueISqtl")
}