VariableLookup {HYPEtools}

Lookup Functions For HYPE Variables

Description

Lookup information (e.g. Name, Units) for a specific HYPE variable ID, or find HYPE variable information for a search term.

Usage

VariableInfo(
  variable,
  info = c("ID", "Name", "Unit", "Description", "Aggregation", "Reference", "Component")
)

VariableSearch(
  search,
  info = c("ID", "Name", "Unit", "Description", "Aggregation", "Reference", "Component"),
  ignore_case = TRUE
)

Arguments

variable

String, HYPE Variable ID (e.g. "COUT").

info

A vector of strings describing HYPE variable attribute information to return/search: "ID", "Name", "Unit", "Description", "Aggregation", and/or "Component".

search

String, search HYPE variable info for string matches in info attributes.

ignore_case

Logical, should case differences be ignored in the match?

Details

The VariableInfo and VariableSearch functions provide features to lookup information on HYPE variables from the HYPE Wiki. VariableInfo can be used to return information (e.g. Name, Units) for a known HYPE Variable ID. VariableSearch can be used to search for e.g. an unknown HYPE variable ID based on a search term. The info argument can be used to select which information to return or search.

Value

VariableInfo Returns a named list of the selected info for the specified variable ID. VariableInfo returns a tibble of the search results.

Examples

VariableInfo(variable = "COUT", info = c("Name","Unit"))
VariableSearch(search = "ccSS", info = c("ID", "Name", "Description"))