search_param: Search Global Parameters

In ge-flight-analytics/Rems: R EMS API Wrapper

Search Global Parameters

Description

Search for global parameters matching a substring.

Usage

search_param(
  anal,
  keyword,
  category = c("full", "physical", "logical"),
  flight_record = NULL,
  group = NULL,
  max_results = NULL
)

Arguments

anal	An analytic object (an element of list returned by tseries_query)
keyword	A character string to search for in the parameter names.
category	Kind of parameter to search. Defaults to 'full' (all available.)
flight_record	Optional flight record to restrict search to.
group	A group ID to restrict the search to. Defaults to all group IDs.
max_results	Defaults to 200 - if set to 0, it will return all results.

Details

This function uses the analytic element of a time series query to search for global parameters matching a substring. It will return a list containing all the parameters that match the substring, as well as their EMS GUIDs, names, descriptions, and units.

Value

A list of parameters lists (list of lists) with the following fields:

• id: EMS GUID of the parameter

• name: Name of the parameter

• description: Description of the parameter

• units: the units of the parameter, if available

• metadata: any associated metadata text, if available

• ems_id: EMS ID of the analytic

Examples

## Not run: 
# Connect to EMS
conn <- connect("http://localhost:8080")
# Get a time series query object
qry <- tseries_query(conn, 1)
# Search for parameters with keyword "weather"
prm <- search_param(qry$analytic, "weather")

## End(Not run)

ge-flight-analytics/Rems documentation built on May 17, 2023, 8:02 a.m.