Skip to contents

Get Maintenance Message

Source: R/get_maintenance_message.R
get_maintenance_message.Rd

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

Value

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

Details

Note this typically returns an empty tibble.

See also

Other Admin Endpoints: get_news_item()

Examples

get_maintenance_message()
#> 
#> ── Paging info ─────────────────────────────────────────────────────────────────
#> • numberOfPages = 0
#> • page = 0
#> • maxItemsPerPage = 250
#> • totalNumberOfItems = 0
#> # A tibble: 0 × 0