Actuarial Climate Index
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘xaci’ version 0.1.0
Help Pages
| .spatraster_to_list | Convert a (small) SpatRaster back to the package's plain-list format |
| aci | Actuarial Climate Index (ACI) |
| aggregate_granularity | Aggregate a monthly data frame to a given temporal granularity |
| animate_aci_map | Animate the ACI or a component over time |
| apply_mask | Apply a country mask to a NetCDF data array |
| apply_mask_terra | Apply a country mask to a SpatRaster |
| assign_sealevel_to_admin | Assign PSMSL tide-gauge stations to administrative units and compute coastal factors |
| build_admin_mask | Build a spatial weight matrix mapping ERA5 grid cells to administrative units |
| calculate_aci | Calculate the Actuarial Climate Index |
| calculate_halfday_component | Calculate the half-day (day or night) temperature component |
| calculate_halfday_component_terra | Calculate the half-day (day or night) temperature component (terra version) |
| calculate_maximum_precipitation_over_window | Calculate maximum precipitation over a rolling window |
| calculate_maximum_precipitation_over_window_terra | Calculate maximum precipitation over a rolling window (terra version) |
| calculate_percentiles | Compute temperature percentile thresholds for each day of year |
| calculate_percentiles_terra | Compute temperature percentile thresholds for each day of year (terra version) |
| calculate_period_wind_exceedance_frequency | Calculate monthly wind exceedance frequency |
| calculate_period_wind_exceedance_frequency_terra | Calculate monthly wind exceedance frequency (terra version) |
| calculate_rolling_sum | Calculate the rolling sum of a climate variable |
| cds_set_key | Set your CDS Personal Access Token |
| component | Base Climate Component Helpers |
| component_terra | Terra-based Loading and Hourly-to-Daily Reduction |
| days_above_wind_thresholds | Calculate days with wind power above the 90th-percentile threshold |
| download | Download ERA5 and Country Mask Data |
| download_era5 | Download an ERA5 variable from the Copernicus CDS |
| download_era5_all | Download all ERA5 variables required by the xaci package |
| download_mask | Download the country mask from the Copernicus CDS |
| drought | Drought Component of the ACI |
| drought_component | Calculate the drought component of the ACI |
| drought_component_terra | Calculate the drought component of the ACI (terra version) |
| drought_interpolate | Linearly interpolate annual CDD to monthly resolution |
| drought_terra | Terra-based Drought Component |
| load_component | Load a NetCDF dataset and optionally apply a country mask |
| load_component_terra | Load a NetCDF variable and optionally apply a country mask (terra version) |
| load_netcdf_terra | Lazily load a NetCDF variable as a terra SpatRaster |
| load_psmsl_data | Load the bundled PSMSL station metadata |
| max_consecutive_dry_days | Calculate maximum consecutive dry days (CDD) per year |
| max_consecutive_dry_days_terra | Calculate maximum consecutive dry days (terra version) |
| plot_aci_components | Plot the ACI component decomposition |
| plot_aci_dashboard | Plot a summary dashboard of the ACI results |
| plot_aci_distribution | Plot the distribution of ACI components |
| plot_aci_map | Plot a spatial map of the ACI or one of its components |
| plot_aci_map_mean | Plot the temporal mean of an ACI variable over a sub-period |
| plot_aci_timeseries | Plot the ACI global time series |
| precipitation | Precipitation Component of the ACI |
| precipitation_component | Calculate the precipitation component of the ACI |
| precipitation_component_terra | Calculate the precipitation component of the ACI (terra version) |
| precipitation_terra | Terra-based Precipitation Component |
| reduce_dataarray_to_dataframe | Reduce a standardised spatial metric to a data frame |
| request_sealevel_data | Download PSMSL tide-gauge data for a country |
| resample_daily_terra | Resample a SpatRaster to daily resolution (terra version) |
| sealevel | Sea Level Component of the ACI |
| sealevel_clean_data | Replace PSMSL sentinel values (-99999) with NA |
| sealevel_component | Calculate the sea-level component of the ACI |
| sealevel_compute_monthly_stats | Compute monthly reference statistics for sea-level data |
| sealevel_correct_date_format | Correct PSMSL float date format to Date objects |
| sealevel_load_data | Load sea-level txt files from a directory |
| sealevel_process | Full sea-level processing pipeline |
| sealevel_standardize_data | Standardise sea-level data over the study period |
| standardize_metric | Standardise a monthly metric relative to a reference period |
| temperature | Temperature Component of the ACI |
| temperature_component | Calculate the full temperature component of the ACI |
| temperature_component_terra | Compute the temperature ACI component (terra version) |
| temperature_terra | Terra-based Temperature Component |
| temp_extremum | Compute daily temperature extremum (min or max) for day or night hours |
| temp_extremum_terra | Compute daily temperature extremum (min or max) for day or night hours (terra version) |
| utils | Utility Functions for ACI Package |
| visualization | Visualization Functions for the ACI Package |
| wind | Wind Component of the ACI |
| wind_component | Calculate the wind component of the ACI |
| wind_component_terra | Calculate the wind component of the ACI (terra version) |
| wind_power | Calculate daily wind power from u10 and v10 components |
| wind_power_terra | Calculate daily wind power from u10 and v10 components (terra version) |
| wind_terra | Terra-based Wind Component |
| wind_thresholds | Calculate wind power thresholds (90th percentile per day-of-year) |