get_result_parameters: Get parameters to define valid results in queries

View source: R/frontend.R

get_result_parametersR Documentation

Get parameters to define valid results in queries

Description

Request information about all valid result columns to request from Arctos.

Usage

get_result_parameters()

Value

Data frame listing valid result columns and associated description and category. The returned columns are: display, obj_name, query_cost, category, description, default_order. The names in obj_name are passed to get_records in the columns parameter as a list.

Examples

library(ArctosR)

if (interactive()) {
  r <- get_result_parameters()
}


ArctosR documentation built on Sept. 16, 2025, 1:10 a.m.