getExceedance: Function to calculate exceedance plots and tables

View source: R/metocean.R

getExceedanceR Documentation

Function to calculate exceedance plots and tables

Description

Function to calculate exceedance plots and tables

Usage

getExceedance(df, variable, percentiles = c(c(0, 0.01, 0.02, 0.05), seq(0.1,
  0.9, 0.1), c(0.95, 0.98, 0.99, 1)), xlabel, type = "annual",
  hemisphere = "northern", output_type = "plot")

Arguments

df

time series of metocean data

variable

index of variable for plotting

percentiles

list of percentiles between 0 and 1

xlabel

string input of xlab for plots

type

string 'monthly' 'season'

hemisphere

southern or northern

Value

dataframe of exceedances

Examples

getExceedance()

rhydar/Metocean documentation built on May 9, 2022, 1:54 p.m.