RequestOptions {rPDBapi}

Define Options for Search Requests

Description

Sets various options for RCSB PDB search requests, such as pagination and sorting.

Usage

RequestOptions(
  result_start_index = NULL,
  num_results = NULL,
  sort_by = "score",
  desc = TRUE
)

Arguments

result_start_index

An integer specifying the starting index for result pagination, default is NULL.

num_results

An integer specifying the number of results to return, default is NULL.

sort_by

A string indicating the attribute to sort by, default is 'score'.

desc

A boolean indicating whether sorting should be in descending order, default is TRUE.

Value

A list of request options.