Generate Spatial Correlations Endpoint

Returns cross-station correlation matrices for wave height, wind speed, and Hmax.

Usage

generate_api_spatial(pair_wave, pair_wind, pair_hmax)

Arguments

pair_wave

Data frame from analyze_station_pairs() for wave height.

pair_wind

Data frame from analyze_station_pairs() for wind speed.

pair_hmax

Data frame from analyze_station_pairs() for Hmax.

Value

A list with _meta and data fields.

See also

Other api: api_plumber, api_static, create_api_router(), generate_api_decomposition(), generate_api_extremes(), generate_api_gust_factors(), generate_api_index(), generate_api_latest(), generate_api_methods(), generate_api_sources(), generate_api_status(), generate_api_trends(), run_api()

Examples

if (FALSE) { # \dontrun{
dm <- data.frame(station1 = "M2", station2 = "M3", distance_km = 150)
cr <- data.frame(station1 = "M2", station2 = "M3", correlation = 0.85)
ed <- data.frame(station1 = "M2", station2 = "M3", chi = 0.3)
generate_api_spatial(dm, cr, ed)
} # }