get_downloads_page_data: Get Downloads Page Data

In gtexr: Query the GTEx Portal API

Get Downloads Page Data

Description

Retrieves all the files belonging to the given project_id for display on the ⁠Downloads Page⁠

GTEx Portal API documentation

Usage

get_downloads_page_data(project_id, .return_raw = FALSE)

Arguments

project_id	String. Options: "gtex", "adult-gtex", "egtex".
.return_raw	Logical. If TRUE, return the raw API JSON response. Default = FALSE

Details

Note: The GTEx Portal API documentation states "GTEx currently has one project available: gtex". However, project_id values "adult-gtex" and "egtex" both return results, whereas "gtex" does not (see examples).

Value

A tibble. Or a list if .return_raw = TRUE.

See Also

Other Datasets Endpoints: get_annotation(), get_collapsed_gene_model_exon(), get_file_list(), get_full_get_collapsed_gene_model_exon(), get_functional_annotation(), get_linkage_disequilibrium_by_variant_data(), get_linkage_disequilibrium_data(), get_sample_datasets(), get_subject(), get_tissue_site_detail(), get_variant(), get_variant_by_location()

Examples

## Not run: 
# "adult-gtex" (default `project_id` value) and "egtex" both return results
get_downloads_page_data("adult-gtex")
egtex <- get_downloads_page_data("egtex")
egtex

# ..."gtex" does not
get_downloads_page_data("gtex")

# get details for whole blood methylation data, including download URL
purrr::pluck(
  egtex$children,
  1,
  "folders",
  "Methylation - EPIC Array",
  "children",
  "folders",
  "mQTLs",
  "children",
  "files",
  "WholeBlood.mQTLs.regular.txt.gz"
)

## End(Not run)

gtexr documentation built on June 8, 2025, 10:26 a.m.