get_all_pages: Get all pages of a paginated call

get_all_pagesR Documentation

Get all pages of a paginated call

Description

Given a Gemma.R output from a function with offset and limit arguments, returns the output from all pages. All arguments other than offset, limit

Usage

get_all_pages(
  query,
  step_size = 100,
  binder = rbind,
  directory = NULL,
  file = getOption("gemma.file", NA_character_),
  overwrite = getOption("gemma.overwrite", FALSE)
)

Arguments

query

Output from a gemma.R function with offset and limit argument

step_size

Size of individual calls to the server. 100 is the maximum value

binder

Binding function for the calls. If raw = FALSE use rbind to combine the data.tables. If not, use c to combine lists

directory

Directory to save the output from the individual calls to. If provided, each page is saved to separate files.

file

The name of a file to save the results to, or NULL to not write results to a file. This function always saves the output as an RDS file. Otherwise, it will be a RDS file.

overwrite

Whether or not to overwrite if a file exists at the specified filename.

Value

A data.table or a list containing data from all pages.


jsicherman/GemmAPI documentation built on Dec. 15, 2024, 8:59 a.m.