heatwave3
The Goal of this package is to make life easier when working with the Hobday et al. marine heatwave definition on large datasets.
https://github.com/robwschlegel/heatwave3
Category: Hydrosphere
Sub Category: Ocean Carbon and Temperature
Last synced: about 13 hours ago
JSON representation
Repository metadata
Apply the Hobday et al. (2016, 2018) marine heatwave definition directly to NetCDF files.
- Host: GitHub
- URL: https://github.com/robwschlegel/heatwave3
- Owner: robwschlegel
- License: other
- Created: 2023-07-29T12:45:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-13T16:45:16.000Z (11 months ago)
- Last Synced: 2025-04-18T21:34:41.222Z (9 days ago)
- Language: R
- Homepage: https://robwschlegel.github.io/heatwave3/
- Size: 2.48 MB
- Stars: 8
- Watchers: 5
- Forks: 0
- Open Issues: 0
- Releases: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
README.md
heatwave3
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.
Owner metadata
- Name: Robert William Schlegel
- Login: robwschlegel
- Email:
- Kind: user
- Description: Data scientist for FACE-IT. What are the key drivers of change in Arctic fjord systems, and what is humanities role?
- Website: https://theoceancode.netlify.com/
- Location: Villefranche, France
- Twitter: robwschlegel
- Company: Institut de la mer de Villefranche
- Icon url: https://avatars.githubusercontent.com/u/7559399?u=95859736f0af87fb84c542a191062b56a6e977fa&v=4
- Repositories: 31
- Last ynced at: 2024-06-11T16:00:21.026Z
- Profile URL: https://github.com/robwschlegel
GitHub Events
Total
- Watch event: 2
Last Year
- Watch event: 2
Committers metadata
Last synced: 8 days ago
Total Commits: 44
Total Committers: 4
Avg Commits per committer: 11.0
Development Distribution Score (DDS): 0.205
Commits in past year: 2
Committers in past year: 1
Avg Commits per committer in past year: 2.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| Robert William Schlegel | r****l@g****m | 35 |
| GuiSPinto | k****e@g****m | 6 |
| Robert | r****l@i****r | 2 |
| Lily Genevier | 6****n | 1 |
Committer domains:
- imev-mer.fr: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 2
Total pull requests: 0
Average time to close issues: 3 months
Average time to close pull requests: N/A
Total issue authors: 2
Total pull request authors: 0
Average comments per issue: 9.0
Average comments per pull request: 0
Merged pull request: 0
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- geografif (1)
- aonojeghuo (1)
Top Pull Request Authors
Top Issue Labels
Top Pull Request Labels
Dependencies
- actions/checkout v3 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- R >= 2.10 depends
- heatwaveR * imports
- terra * imports
- testthat >= 3.0.0 suggests
Score: 3.465735902799726