get_maintenance_message: Get Maintenance Message

In gtexr: Query the GTEx Portal API

Get Maintenance Message

Description

Getting all the maintenance messages from the database that are enabled.

GTEx Portal API documentation.

Usage

get_maintenance_message(
  page = 0,
  itemsPerPage = getOption("gtexr.itemsPerPage"),
  .verbose = getOption("gtexr.verbose"),
  .return_raw = FALSE
)

Arguments

page	Integer (default = 0).
itemsPerPage	Integer (default = 250). Set globally to maximum value 100000 with options(list(gtexr.itemsPerPage = 100000)).
.verbose	Logical. If TRUE (default), print paging information. Set to FALSE globally with options(list(gtexr.verbose = FALSE)).
.return_raw	Logical. If TRUE, return the raw API JSON response. Default = FALSE

Details

Note this typically returns an empty tibble.

Value

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

See Also

Other Admin Endpoints: get_news_item()

Examples

## Not run: 
get_maintenance_message()

## End(Not run)

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