get_subject {gtexr} | R Documentation |
Get Subject
Description
This service returns information of subjects used in analyses from all datasets. Results may be filtered by dataset ID, subject ID, sex, age bracket or Hardy Scale. By default, this service queries the latest GTEx release.
Usage
get_subject(
datasetId = "gtex_v8",
sex = NULL,
ageBrackets = NULL,
hardyScale = NULL,
subjectIds = NULL,
page = 0,
itemsPerPage = getOption("gtexr.itemsPerPage"),
.verbose = getOption("gtexr.verbose"),
.return_raw = FALSE
)
Arguments
datasetId |
String. Unique identifier of a dataset. Usually includes a data source and data release. Options: "gtex_v8", "gtex_snrnaseq_pilot". |
sex |
String. Options: "male", "female". |
ageBrackets |
The age bracket(s) of the donors of interest. Options: "20-29", "30-39", "40-49", "50-59", "60-69", "70-79". |
hardyScale |
String A Hardy Scale of interest. Options: "Ventilator case", "Fast death - violent", "Fast death - natural causes", "Intermediate death", "Slow death". |
subjectIds |
Character vector. GTEx subject ID. |
page |
Integer (default = 0). |
itemsPerPage |
Integer (default = 250). Set globally to maximum value
100000 with |
.verbose |
Logical. If |
.return_raw |
Logical. If |
Value
A tibble. Or a list if .return_raw = TRUE
.
See Also
Other Datasets Endpoints:
get_annotation()
,
get_collapsed_gene_model_exon()
,
get_downloads_page_data()
,
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_tissue_site_detail()
,
get_variant()
,
get_variant_by_location()
Examples
## Not run:
get_subject()
## End(Not run)