# Catastrophe Model Simulation and Adjustment

## Documentation for package ‘catmodeling’ version 0.0.1

- DESCRIPTION file.

## Help Pages

addvectors | Adds two vectors element-wise up to length n.
bootstrap_ep_uncertainty | Bootstrap EP uncertainty
calc_beta_params | Calculate Beta Distribution Parameters for a List of Events
catxl | Applies CatXL Layers to a YLT
compare_distance_routines | Function for testing that R and Rust give the same distances between events
defineregion | Defines the 19 Global Regions from My BAMS Paper
elt_add_nahu_cat | Adds a cat column to an elt, calculated from wind speed.
elt_collapse_regions | For an ELT with multiple occurrences of each event, collapses to 1 per event
elt_diagnostics_aaeaal | Calculates AAE and AAL from an ELT
elt_diagnostics_aaeaal_by_cat | Calculates AAE and AAL from an ELT, and by cat
elt_diagnostics_aaeaal_with_adj | Calculates AAE and AAL from an ELT
elt_diagnostics_epcurves | Converts ELT rates into plotting positions for CEP, EEF and OEP
elt_diagnostics_epcurves_with_adj | Converts ELT rates into plotting positions for CEP, EEF and OEP, with rate adjustments
elt_rate_adjustments_cat_2_event | Converts rate adjustments from cat to event, for events in an ELT
elt_rate_adjustments_regcat_2_event | Converts rate adjustments from region and cat to event, for events in an ELT
filetest | Testing using files
hours_clause | Applies an hours clause to a long YLT, and returns a YLT
hours_clause_apply_part2 | Function that loops through events in one year and applies an hours clause
hours_clause_wrapper_ylt | Applies an hours clause to a long YLT stored in csv file, and returns the adjusted YLT in memory and to a csv file
hours_clause_write_settings | When using 'hours_clause_wrapper', writes out the settings to a file.
imports | Imports
input_checks | Checks the columns in an input data frame.
make_2_ep_by_sorting | Make 2 EP curves by sorting losses
make_elt | Make an ELT in memory
make_ep_by_sorting | Make an EP curve by sorting losses
make_ylt | Make an YLT in memory
nahu_define_gmst_scenarios | Defines 4 GMST Scenarios
nahu_define_k2020_zenodo_landfall_adj | Define Jewson landfall rates Scenarios from the BAMS paper
nahu_k2020_rates_interpolation | Interpolates rates in time
nahu_write_settings | Writes out settings to file for 'nahu_ylt_surgery'
nahu_ylt_surgery | An example workflow for applying 'ylt_surgery_groups' or 'ylt_surgery_groups' to NAHU.
rust_dist_haversine | Function to calculate the Haversine distance between two points. This matches the functionality of geosphere::distHaversine in R.
rust_hello_world | Return string '"Hello world!"' to R. Just a test.
rust_hours_clause_apply_part2 | Hours clause function For a given start event, calculates all possible hours clauses, returns new losses AND a counter
rust_square | Square an integer. Just an example.
stopi | Stops code intentionally, with message that says that
template | A template for R code
whatreg | Converts US state and country region abbreviations into numbers from 1 to 7.
writeNresults2csv | Writes results from N YLTs to csv format.
ws2catf | Convert windspeed in knots into a generalized version of the SSHWS category.
yltsim | Simulates a long YLT from a Poisson ELT
yltsim_inc | Simulates an Adjusted long YLT using Incremental Simulation, based on an input ELT and long YLT
yltsurgery | Adjusts a long YLT to make a new long YLT using the surgery algorithm
yltsurgery_groups | Adjusts a long YLT to make a new long YLT using the grouped surgery algorithm
ylt_add_cat_2_longylt | Adds a cat column to a long ylt, based on windspeed
ylt_add_region_2_longylt | Adds a region column to a longylt, based on the lat-lons already in the longylt
ylt_check_for_2_events_on_same_day | Checks a YLT for two events on the same day
ylt_check_for_same_events_in_one_year | Checks a YLT for the same event occurring twice in one year
ylt_diagnostics_aaeaal | Long YLT Diagnostics
ylt_diagnostics_aaeaal_by_catf | Calculates YLT AAE and AAL by Cat
ylt_diagnostics_aaeaal_by_cat_change_printf | Prints changes in AAE and AAL from a two YLTs to the screen
ylt_diagnostics_aaeaal_by_cat_printf | Prints AAE and AAL from a YLT to the screen
ylt_diagnostics_aaeaal_change_printf | Prints changes in AAE and AAL from a two longylts to the screen
ylt_diagnostics_aaeaal_printf | Prints AAE and AAL from a Long YLT to the screen
ylt_diagnostics_loss_thresholds | Counts number of events per year above loss thresholds
ylt_diagnostics_nchanges | Sees how many years have changed between a YLT and an adjusted YLT
ylt_long2short | Calculate a Short YLT from a Long YLT
ylt_rate_adjustments_catreg_2_row | Makes rates adjustments by event, for events in a YLT
ylt_rate_adjustments_cat_2_row | Makes rates adjustments by event, for events in a YLT
ylt_write2results2csv | Writes results from 2 YLTs to csv format.