Skip to contents

Query the POWER API for detailed information on available parameters

Source: R/query_parameters.R
query_parameters.Rd

Queries the POWER API returning detailed information on available parameters. For a list of all available parameters, use parameters

Usage

query_parameters(
  community = NULL,
  pars = NULL,
  temporal_api = NULL,
  metadata = FALSE
)

Arguments

community

An optional character vector providing community name: “ag”, “sb” or “re”.

pars

An optional character string of a single solar, meteorological or climatology parameter to query. If none is provided, all are returned.

temporal_api

An optional character vector indicating the temporal API end-point for data being queried, supported values are “hourly”, “daily”, “monthly” or “climatology”.

metadata

Boolean; retrieve extra parameter metadata? This is only applicable if you supply the community and temporal_api, if these values are not provided it will be ignored. Defaults to FALSE.

Value

A list object of information for the requested parameter(s) (if requested), community(ies) and temporal API(s).

Argument details for temporal_api

There are four valid values.

hourly

The hourly average of pars by hour, day, month and year.

daily

The daily average of pars by day, month and year.

monthly

The monthly average of pars by month and year.

climatology

Provide parameters as 22-year climatologies (solar) and 30-year climatologies (meteorology); the period climatology and monthly average, maximum, and/or minimum values.

Author

Adam H. Sparks, adamhsparks@gmail.com

Examples

if (FALSE) { # interactive()

# fetch the complete set of attribute information for "T2M".
query_parameters(pars = "T2M")

# fetch complete temporal and community specific attribute information
# for "T2M" in the "ag" community for the "hourly" temporal API.
query_parameters(
  pars = "T2M",
  community = "ag",
  temporal_api = "hourly"
)

# fetch complete temporal and community specific attribute information
# for all parameters in the "ag" community for the "hourly" temporal API.
query_parameters(
  community = "ag",
  temporal_api = "hourly"
)
}