Welcome to heatwave3. The goal of this package is to make life easier when working with the Hobday et al. (2016, 2018) marine heatwave (MHW) definition on large datasets. Traditionally we have had to detect MHWs on one time series at a time. For large gridded datasets this can be technically difficult and very time consuming. Now, thanks to developments in the terra package, it is possible to apply any numbers of functions directly to gridded data (e.g. NetCDF files). heatwave3 therefore serves as an extension to the heatwaveR package and helps the user to easily and quickly detect MHWs within their gridded datasets. The results can be returned as either a stacked raster or data.frame. This package can also save the results directly as a NetCDF or CSV file.
The package is still in its infancy and is being actively developed. Any and all feedback is very welcome!
Installation
You can install the development version of heatwave3 from this GitHub repository with:
# install.packages("devtools")
devtools::install_github("robwschlegel/heatwave3")Example
The use of heatwave3 has been designed to be as easy as possible. There is a lot happening behind the scenes that allows this package to determine the structure of the users data without needing to provide any additional arguments. Please see the following example:
library(heatwave3)
# Run directly on a file without needing to load it first
mhw_cube <- detect3(file_in = system.file("extdata/oisst_short.nc", package = "heatwave3"),
return_type = "df", clim_period = c("1982-01-01", "2011-12-31"))
# Show the first few rows
head(mhw_cube)Of course, there are possibly more ways to organise a data file than there are stars in the sky. If this function doesn’t work on your dataset, please contact us! We are actively looking for ways to improve the usability of heatwave3
Code of Conduct
Please note that the heatwave3 project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
