data-prep.Rmd

---
title: "Preparing the data"
author: "Robert Schlegel"
date: "2020-02-25"
output: workflowr::wflow_html
editor_options:
  chunk_output_type: console
csl: FMars.csl
bibliography: MHWflux.bib
---

```{r global_options, include = FALSE}
knitr::opts_chunk$set(fig.width = 8, fig.align = 'center',
                      echo = TRUE, warning = FALSE, message = FALSE, 
                      eval = TRUE, tidy = FALSE)
```

## Introduction

The purpose of this vignette is to walk through the steps taken to prepare the data from the NOAA OISST, ERA5, and GLORYS products for the following analyses. The statistical analyses may be found in the [MHWs vs. heat flux]() vignette, and the SOM analysis may be found in the [SOM]() vignette. 

All of the libraries and functions used in this vignette, and the project more broadly, may be found [here](https://github.com/robwschlegel/MHWflux/blob/master/code/functions.R).

```{r satrtup}
# get everything up and running in one go
source("code/functions.R")
library(ggpubr)
library(gridExtra)
library(FNN)
```

## Study area

A reminder of what the study area looks like. It has been cut into 6 regions, adapted from work by @Richaud2016.

```{r region-fig}
frame_base +
  geom_polygon(data = NWA_coords, alpha = 0.7, size = 2,
               aes(fill = region, colour = region)) +
  geom_polygon(data = map_base, aes(group = group))
```

## Pixels per region

In this study it was decided to use the higher resolution 1/12th degree GLORYS data. This means we will need to re-calculate which pixels fall within which region so we can later determine how to create our average SST time series per region as well as the other averaged heat flux term time series.

For the SOM we will want to have everything on the same 1/4 degree grid. For the ERA5 data this is an easy shift to make, but for the GLORYS 1/12 degree data we want to ensure that these smaller pixels are being matched correctly to the nearest centre of an OISST pixels. To do this we will create an index of pairings using a fastest nearest neighbour search.

```{r grid-points, eval=FALSE}
# Load one OISST file to extract the lon/lat coords
OISST_grid <- readRDS("../data/OISST/daily/1982/daily.1982-01-01.Rda") %>% 
  dplyr::select(lon, lat) %>% 
  filter(lon >= NWA_corners[1], lon <= NWA_corners[2],
         lat >= NWA_corners[3], lat <= NWA_corners[4]) %>% 
  unique() %>% 
  mutate(OISST_index = 1:n()) # For merging to GLORYS grid
saveRDS(OISST_grid[,1:2], "metadata/OISST_grid.Rda")

# Load one high-res GLORYS file to extract the lon/lat coords
GLORYS_grid_base <- tidync(GLORYS_files[1]) %>% 
  hyper_tibble() %>% 
  dplyr::rename(lon = longitude, lat = latitude) %>% 
  filter(lon >= NWA_corners[1], lon <= NWA_corners[2],
         lat >= NWA_corners[3], lat <= NWA_corners[4]) %>% 
  dplyr::select(lon, lat) %>% 
  unique()

# Add on the nearest OISST coords
GLORYS_grid <- GLORYS_grid_base %>% 
  mutate(OISST_index = as.vector(knnx.index(as.matrix(OISST_grid[,c("lon", "lat")]),
                                            as.matrix(GLORYS_grid_base[,c("lon", "lat")]), k = 1))) %>%
  left_join(OISST_grid, by = "OISST_index") %>% 
  dplyr::select(-OISST_index) %>% 
  dplyr::rename(lon = lon.x, lat = lat.x, lon_OISST = lon.y, lat_OISST = lat.y)
saveRDS(GLORYS_grid, "metadata/GLORYS_grid.Rda")

# Load one ERA5 file to get the lon/lat coords
ERA5_grid <- tidync(ERA5_lhf_files[1]) %>%
  hyper_filter(latitude = dplyr::between(latitude, NWA_corners[3], NWA_corners[4]),
               longitude = dplyr::between(longitude, NWA_corners[1]+360, NWA_corners[2]+360),
               time = index == 1) %>%
  hyper_tibble() %>%
  dplyr::rename(lon = longitude, lat = latitude) %>%
  dplyr::select(lon, lat) %>%
  mutate(lon = lon-360) %>%  # Change back to +-180 scale
  mutate(lon = lon+0.125, lat = lat-0.125) %>%  # Regrid to match OISST coords
  filter(lon >= NWA_corners[1], lon <= NWA_corners[2],
         lat >= NWA_corners[3], lat <= NWA_corners[4]) %>% 
  unique()
saveRDS(ERA5_grid, "metadata/ERA5_grid.Rda")

# Test visuals
  # Choose one
# OISST_grid %>%
# GLORYS_grid %>%
ERA5_grid %>%
  ggplot(aes(x = lon, y = lat)) +
  geom_raster() +
  coord_quickmap(xlim = NWA_corners[1:2], ylim = NWA_corners[3:4], expand = F)
  
# Function for finding and cleaning up points within a given region polygon
points_in_region <- function(region_in, product_grid){
  region_sub <- NWA_coords %>% 
    filter(region == region_in)
  coords_in <- product_grid %>% 
    mutate(in_grid = sp::point.in.polygon(point.x = product_grid[["lon"]], point.y = product_grid[["lat"]], 
                                          pol.x = region_sub[["lon"]], pol.y = region_sub[["lat"]])) %>% 
    filter(in_grid >= 1) %>% 
    mutate(region = region_in) %>% 
    dplyr::select(lon, lat, region)
  return(coords_in)
}

# Run the function
registerDoParallel(cores = 10)
OISST_regions <- plyr::ldply(unique(NWA_coords$region), points_in_region, 
                              .parallel = T, product_grid = OISST_grid)
saveRDS(OISST_regions, "metadata/OISST_regions.Rda")
GLORYS_regions <- plyr::ldply(unique(NWA_coords$region), points_in_region, 
                              .parallel = T, product_grid = GLORYS_grid)
saveRDS(GLORYS_regions, "metadata/GLORYS_regions.Rda")
ERA5_regions <- plyr::ldply(unique(NWA_coords$region), points_in_region, 
                            .parallel = T, product_grid = OISST_grid) # We only want ocean pixels
saveRDS(ERA5_regions, "metadata/ERA5_regions.Rda")

# Test visuals
  # Choose one
# OISST_regions %>%
# GLORYS_regions %>%
ERA5_regions %>%
  ggplot(aes(x = lon, y = lat)) +
  geom_raster(aes(fill = region)) +
  scale_x_continuous(breaks = seq(-80, -40, 2)) +
  scale_y_continuous(breaks = seq(32, 52, 2)) +
  coord_quickmap(xlim = NWA_corners[1:2], ylim = NWA_corners[3:4], expand = T)
```

```{r grid-points-visual}
OISST_regions <- readRDS("metadata/OISST_regions.Rda")
GLORYS_regions <- readRDS("metadata/GLORYS_regions.Rda")
ERA5_regions <- readRDS("metadata/ERA5_regions.Rda")

# Combine for visual
ALL_regions <- rbind(OISST_regions, GLORYS_regions, ERA5_regions) %>%
  mutate(product = c(rep("OISST", nrow(OISST_regions)),
                     rep("GLORYS", nrow(GLORYS_regions)),
                     rep("ERA5", nrow(ERA5_regions))))

# Visualise to ensure success
ggplot(NWA_coords, aes(x = lon, y = lat)) +
  geom_polygon(data = map_base, aes(group = group), show.legend = F) +
  geom_point(data = ALL_regions, aes(colour = region), size = 0.1) +
  coord_quickmap(xlim = NWA_corners[1:2], ylim = NWA_corners[3:4], expand = F) +
  labs(x = NULL, y = NULL, colour = "Region") +
  facet_wrap(~product) +
  guides(colour = guide_legend(override.aes = list(shape = 15, size = 5)))
ggsave(filename = "output/NWA_product_regions.pdf", height = 5, width = 18)
```

With our pixels per region determined we may now go about creating the average time series for each region from the OISST, GLORYS, and ERA5 data.

## OISST data processing

Up first for processing are the OISST data. The full brick of data within the study area will be loaded first. Then the pixels within the regions are pulled out and individual time series are made from each and saved. Finally the climatologies and anomalies for each pixel in the study area are calculated and saved. The region clims+anoms are calculated for all of the data at the same time near the end of this vignette.

```{r OISST_prep, eval=FALSE}
# The files with data in the study area
OISST_files_sub <- data.frame(files = OISST_files,
                              lon = c(seq(0.125, 179.875, by = 0.25), 
                                      seq(-179.875, -0.125, by = 0.25))) %>% 
  filter(lon >= NWA_corners[1], lon <= NWA_corners[2]) %>% 
  mutate(files = as.character(files))

# Load the full grid for the study area
system.time(
OISST_all <- plyr::ldply(OISST_files_sub$files, .fun = load_OISST, .parallel = TRUE)
) # 16 seconds

# Check that the coords were subsetted correctly
NWA_corners
min(OISST_all$lon); max(OISST_all$lon)
min(OISST_all$lat); max(OISST_all$lat)

# test visual
OISST_all %>%
  filter(t == "1993-01-01") %>%
  ggplot(aes(x = lon, y = lat)) +
  geom_raster(aes(fill = temp)) +
  scale_x_continuous(breaks = seq(-80, -40, 2)) +
  scale_y_continuous(breaks = seq(32, 52, 2)) +
  coord_quickmap(xlim = NWA_corners[1:2], ylim = NWA_corners[3:4], expand = T)

# Create the region time series and save
system.time(
OISST_all_ts <- OISST_all %>%
  right_join(OISST_regions, by = c("lon", "lat")) %>% 
  group_by(region, t) %>%
  summarise(temp = mean(temp, na.rm = T), .groups = "drop")
) # 14 seconds
saveRDS(OISST_all_ts, "data/OISST_all_ts.Rda")

# test visual
OISST_all_ts %>% 
  ggplot(aes(x = t, y = temp)) + 
  geom_line(aes(colour = region)) +
  facet_wrap(~region) +
  labs(x = NULL, y = "Temp. (C)")

# Calculate the clims and anoms for each pixel
registerDoParallel(cores = 25)
system.time(
OISST_all_anom <- OISST_all %>% 
  mutate(var = "temp") %>% 
  dplyr::rename(val = temp) %>% 
  plyr::ddply(., c("lon", "lat", "var"), calc_clim_anom, .parallel = T, point_accuracy = 2)
) # 214 seconds
saveRDS(OISST_all_anom, "data/OISST_all_anom.Rda")

# test visual
OISST_all_anom %>%
  filter(t == "1998-06-18") %>% 
  ggplot(aes(x = lon, y = lat)) + 
  geom_polygon(data = map_base, aes(group = group), show.legend = F) +
  geom_tile(aes(fill = anom)) +
  scale_x_continuous(breaks = seq(-80, -40, 2)) +
  scale_y_continuous(breaks = seq(32, 52, 2)) +
  scale_fill_gradient2(low = "blue", high = "red") +
  labs(x = NULL, y = NULL) +
  coord_quickmap(xlim = NWA_corners[1:2], ylim = NWA_corners[3:4], expand = T) 
```

## GLORYS data processing

We are using the 1/12 degree GLORYS product for the calculations of the region time series in order to better capture the sub-mesoscale processes that may be associated with the driving of MHWs. For the broad synoptic scale data given to the SOM we will be using the 1/4 degree GLORYS product as it needs to be the same resolution as the other products being used.

```{r GLORYS-prep, eval=FALSE}
# NB: This is very RAM heavy, be careful with core use

# Process and save the region time series
registerDoParallel(cores = 25)
system.time(
GLORYS_all_ts <- plyr::ldply(GLORYS_files, load_GLORYS, .parallel = T, region = T) %>%
  dplyr::arrange(region, t) %>% 
  mutate(cur_spd = round(sqrt(u^2 + v^2), 4),
         cur_dir = round((270-(atan2(v, u)*(180/pi)))%%360))
) # 202 seconds on 25 cores
saveRDS(GLORYS_all_ts, "data/GLORYS_all_ts.Rda")

# test visual
GLORYS_all_ts %>% 
  ggplot(aes(x = t, y = mld)) + 
  geom_line(aes(colour = region)) +
  facet_wrap(~region) +
  labs(x = NULL, y = "MLD (m)")

# Load and prep the GLORYS data for the entire study area
registerDoParallel(cores = 25)
system.time(
GLORYS_all <- plyr::ldply(GLORYS_files, load_GLORYS, 
                          .parallel = T, .paropts = c(.inorder = FALSE))
) # 293 seconds on 25 cores

# test visual
GLORYS_all %>%
  filter(t == "1993-01-01") %>%
  ggplot(aes(x = lon, y = lat)) +
  geom_raster(aes(fill = mld)) +
  scale_x_continuous(breaks = seq(-80, -40, 2)) +
  scale_y_continuous(breaks = seq(32, 52, 2)) +
  coord_quickmap(xlim = NWA_corners[1:2], ylim = NWA_corners[3:4], expand = T)

# Calculates clims+anoms and save
registerDoParallel(cores = 25)
system.time(
GLORYS_all_anom <- GLORYS_all %>% 
  pivot_longer(cols = c(-lon, -lat, -t), names_to = "var", values_to = "val") %>% 
  plyr::ddply(., c("lon", "lat", "var"), calc_clim_anom, .parallel = T, 
              point_accuracy = 6, .paropts = c(.inorder = FALSE))
) # 732 seconds on 25 cores
saveRDS(GLORYS_all_anom, "data/GLORYS_all_anom.Rda")

# test visual
GLORYS_all_anom %>%
  filter(t == "1993-06-18",
         var == "mld") %>% 
  ggplot(aes(x = lon, y = lat)) + 
  geom_polygon(data = map_base, aes(group = group), show.legend = F) +
  geom_tile(aes(fill = anom)) +
  scale_x_continuous(breaks = seq(-80, -40, 2)) +
  scale_y_continuous(breaks = seq(32, 52, 2)) +
  scale_fill_gradient2(low = "blue", high = "red") +
  labs(x = NULL, y = NULL) +
  coord_quickmap(xlim = NWA_corners[1:2], ylim = NWA_corners[3:4], expand = T) 
```

## ERA5 data processing

Note that the ERA5 data are on an hourly 0.25 degree spatiotemporal grid. This loading process constrains them to a daily 0.25 degree grid that matches the OISST data before finally converting them to a single time series per region.

```{r ERA5-prep, eval=FALSE}
# See the code/workflow script for the code used for ERA5 data prep
# There is too much code to run from an RMarkdown document as each variable must loaded individually
```

## MHWs per region

We will be using the SST values from GLORYS for calculating the MHWs and will use the standard Hobday definition with a base period of 1993-01-01 to 2018-12-25. We are using an uneven length year as the data do not quite extend to the end of December. It was decided that the increased accuracy of the climatology from the 2018 year outweighed the negative consideration of having a clim period that excludes a few days of winter.

```{r MHW-calc, eval=FALSE}
# Load the data
OISST_all_ts <- readRDS("data/OISST_all_ts.Rda")

# Calculate the MHWs
OISST_region_MHW <- OISST_all_ts %>%
  group_by(region) %>%
  nest() %>%
  mutate(clims = map(data, ts2clm,
                     climatologyPeriod = c("1993-01-01", "2018-12-25")),
         events = map(clims, detect_event),
         cats = map(events, category, S = FALSE)) %>%
  select(-data, -clims)

# Save
saveRDS(OISST_region_MHW, "data/OISST_region_MHW.Rda")
saveRDS(OISST_region_MHW, "shiny/OISST_region_MHW.Rda")
```

### MHW results

There were some minor changes between the OISST grid used for the original SOM work and this version of the project. So first we want to compare the results of both to see by how much they differ. It should be very little.

```{r}
# New and old MHW results
OISST_MHW_new <- readRDS("data/OISST_region_MHW.Rda") %>% 
  select(-cats) %>%
  unnest(events) %>%
  filter(row_number() %% 2 == 0) %>%
  unnest(events)
OISST_MHW_old <- readRDS("../MHWNWA/data/OISST_region_MHW.Rda")  %>% 
  select(-cats) %>%
  unnest(events) %>%
  filter(row_number() %% 2 == 0) %>%
  unnest(events)

## Max count of events per region
# New
OISST_MHW_new %>% 
  group_by(region) %>% 
  summarise(count = max(event_no))
# Old
OISST_MHW_old %>% 
  group_by(region) %>% 
  summarise(count = max(event_no))

## Average metrics
# New
OISST_MHW_new %>% 
  dplyr::select(region, duration, intensity_mean, intensity_max, intensity_cumulative, rate_onset, rate_decline) %>% 
  group_by(region) %>% 
  summarise_all("mean", na.rm = T)
# Old
OISST_MHW_old %>% 
  dplyr::select(region, duration, intensity_mean, intensity_max, intensity_cumulative, rate_onset, rate_decline) %>% 
  group_by(region) %>% 
  summarise_all("mean", na.rm = T)
```

We can see from the results above that there are some minor differences between the results when using the different grids. This is regrettable as it will almost certainly have some sort of impact on the SOM results. But I think it is necessary that we press forward with results based on the OISST grid as it makes the most sense w.r.t. picking pixels that fall within the region polygons. This will also allow for better subsetting of pixels within the chosen study area.

Because the MHW results themselves are not really the focus of the paper, I will quickly go over them here. Specifically we are looking at the summary stats for MHWs per region and season, and how they may differ between those classifying groups. The stats created here are used in the results section of the manuscript and some of the musings will be used for the discussion.

```{r MHW-results}
# Annual count of MHWs - first MHW
OISST_MHW_event %>%
  mutate(year = year(date_peak)) %>% 
  group_by(year) %>% 
  summarise(count = n()) %>% 
  data.frame()

# Differences between regions
OISST_MHW_event %>% 
  dplyr::select(region, duration, intensity_mean, intensity_max, 
                intensity_cumulative, rate_onset, rate_decline) %>% 
  group_by(region) %>% 
  mutate(count = n()) %>% 
  summarise_all("mean", na.rm = T)

# Differences between regions
OISST_MHW_event %>% 
  ungroup() %>% 
  dplyr::select(season, duration, intensity_mean, intensity_max, 
                intensity_cumulative, rate_onset, rate_decline) %>% 
  group_by(season) %>% 
  mutate(count = n()) %>% 
  summarise_all("mean", na.rm = T)
```

## Region clims + anoms per variable

The analyses to come are going to be performed on anomaly values, not the original time series. In order to calculate the anomalies we are first going to need the climatologies for each variable. We will use the Hobday definition of climatology creation and then subtract the expected climatology from the observed values. We are again using the 1993-01-01 to 2018-12-25 base period for these calculations to ensure consistency throughout the project.

```{r clims, eval=FALSE}
# Load the data
GLORYS_all_ts <- readRDS("data/GLORYS_all_ts.Rda")
ERA5_all_ts <- readRDS("data/ERA5_all_ts.Rda")
OISST_all_ts <- readRDS("data/OISST_all_ts.Rda")
ALL_ts <- left_join(ERA5_all_ts, GLORYS_all_ts, by = c("region", "t")) %>% 
  left_join(OISST_all_ts, by = c("region", "t")) %>% 
  filter(t <= "2018-12-31")

# Calculate GLORYS clims and anoms
  # Also give better names to the variables
  # Also convert the Qx terms from seconds to days by multiplying by 86,400
ALL_ts_anom <- ALL_ts %>%
  dplyr::rename(lwr = msnlwrf, swr = msnswrf, lhf = mslhf, 
                shf = msshf, mslp = msl, sst = temp.y) %>% 
  dplyr::select(-wind_dir, -cur_dir, -temp.x) %>% 
  mutate(qnet_mld = (qnet*86400)/(mld*1024*4000),
         lwr_mld = (lwr*86400)/(mld*1024*4000),
         swr_mld = (swr*86400)/(mld*1024*4000),
         lhf_mld = (lhf*86400)/(mld*1024*4000),
         shf_mld = (shf*86400)/(mld*1024*4000),
         mld_1 = 1/mld) %>% 
  pivot_longer(cols = c(-region, -t), names_to = "var", values_to = "val") %>% 
  group_by(region, var) %>%
  nest() %>%
  mutate(clims = map(data, ts2clm, y = val, roundClm = 10,
                     climatologyPeriod = c("1993-01-01", "2018-12-25"))) %>% 
  dplyr::select(-data) %>% 
  unnest(cols = clims) %>%
  mutate(anom = val-seas) %>% 
  ungroup()

# Save
saveRDS(ALL_ts_anom, "data/ALL_ts_anom.Rda")
saveRDS(ALL_ts_anom, "shiny/ALL_ts_anom.Rda")
```

## Cumulative heat flux terms

We also need to create cumulative heatflux terms as well as a few other choice variables. This is done by taking the first day during the MHW and adding the daily values together cumulatively until the end of the event. The daily values are first divided by the MLD on that day as seen above. The MLD value used to divide the daily variables accounts for the water density and specific heat constant: Q/(rho x Cp x hmld), where rho = 1042 and Cp ~= 4000. Th Qnet term calculated this way approximates the air-sea flux term.

The movement terms aren't very useful and may not be worth including as they don't really show advection. So rather one can say that the parts of the heating that aren't explained by anything else could be attributed to advection through the process of elimination. For the moment they are still left in here.

```{r cum-heat-flux, eval=FALSE}
# We're going to switch over to the NOAA OISST data for MHWs now
ALL_ts_anom_cum <- ALL_ts_anom %>%
  dplyr::select(region, var, t, anom) %>% 
  pivot_wider(id_cols = c("region", "t"), names_from = var, values_from = anom) %>% 
  dplyr::select(region:tcc, mslp, qnet, p_e, mld, mld_1, qnet_mld:shf_mld) %>% 
  left_join(OISST_MHW_clim[,c("region", "t", "event_no")], by = c("region", "t")) %>% 
  filter(event_no > 0) %>% 
  group_by(region, event_no) %>% 
  mutate_if(is.numeric, cumsum) %>% 
  ungroup() %>% 
  dplyr::select(region, event_no, t, everything()) %>% 
  pivot_longer(cols = c(-region, -event_no, -t), names_to = "var", values_to = "anom") %>% 
  mutate(var = paste0(var,"_cum")) %>% 
  dplyr::select(region, var, event_no, t, anom)

# Save
saveRDS(ALL_ts_anom_cum, "data/ALL_ts_anom_cum.Rda")
saveRDS(ALL_ts_anom_cum, "shiny/ALL_ts_anom_cum.Rda")
```

In the [MHWs vs. heat flux](https://robwschlegel.github.io/MHWflux/mhw-flux.html) vignette we will take the periods of time over which MHWs occurred per region and pair those up with the GLORYS and ERA5 data. This will be used to investigate which drivers are best related to the onset and decline of MHWs. In the [SOM](https://robwschlegel.github.io/MHWNWA/som.html) vignette we will look for how 

## References