Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliocamp/metr
Tools for Easier Analysis of Meteorological Fields
https://github.com/eliocamp/metr
atmospheric-science ggplot2 r r-package rstats visualization
Last synced: 2 days ago
JSON representation
Tools for Easier Analysis of Meteorological Fields
- Host: GitHub
- URL: https://github.com/eliocamp/metr
- Owner: eliocamp
- Created: 2017-07-05T20:09:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T02:25:24.000Z (2 months ago)
- Last Synced: 2024-12-19T22:02:50.442Z (4 days ago)
- Topics: atmospheric-science, ggplot2, r, r-package, rstats, visualization
- Language: R
- Homepage: https://eliocamp.github.io/metR/
- Size: 521 MB
- Stars: 144
- Watchers: 5
- Forks: 22
- Open Issues: 15
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
cache = FALSE,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/"
)
set.seed(42)
```
# metR 
[](https://github.com/eliocamp/metR/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/eliocamp/metR)
[](https://CRAN.R-project.org/package=metR)
[](https://zenodo.org/badge/latestdoi/96357263)
metR packages several functions and utilities that make R better for handling meteorological data in the tidy data paradigm. It started mostly sa a packaging of assorted wrappers and tricks that I wrote for my day to day work as a researcher in atmospheric sciences. Since then, it has grown organically and for my own needs and feedback from users.
Conceptually it's divided into *visualization tools* and *data tools*. The former are geoms, stats and scales that help with plotting using [ggplot2](https://ggplot2.tidyverse.org/index.html), such as `stat_contour_fill()` or `scale_y_level()`, while the later are functions for common data processing tools in the atmospheric sciences, such as `Derivate()` or `EOF()`; these are implemented to work in the [data.table](https://github.com/Rdatatable/data.table/wiki) paradigm, but also work with regular data frames.
Currently metR is in development but maturing. Most functions check arguments and there are some tests. However, some functions might change it's interface, and functionality can be moved to other packages, so please bear that in mind.
## Installation
You can install metR from CRAN with:
```{r CRAN-installation, eval = FALSE}
install.packages("metR")
```
Or the development version with:
```{r gh-installation, eval = FALSE}
if (!requireNamespace("pak", quietly = TRUE)) {
install.packages("pak")
}
pak::pak("metR")
```
If you need to read netcdf files, you might need to install the netcdf and udunits2 libraries. On Ubuntu and it's derivatives this can be done by typing
```
sudo apt install libnetcdf-dev netcdf-bin libudunits2-dev
```
## Citing the package
If you use metR in your research, please consider citing it. You can get citation information with
```{r}
citation("metR")
```
## Examples
In this example we easily perform Principal Components Decomposition (EOF) on monthly geopotential height, then compute the geostrophic wind associated with this field and plot the field with filled contours and the wind with streamlines.
```{r field}
library(metR)
library(data.table)
library(ggplot2)
data(geopotential)
# Use Empirical Orthogonal Functions to compute the Antarctic Oscillation
geopotential <- copy(geopotential)
geopotential[, gh.t.w := Anomaly(gh)*sqrt(cos(lat*pi/180)),
by = .(lon, lat, month(date))]
aao <- EOF(gh.t.w ~ lat + lon | date, data = geopotential, n = 1)
aao$left[, c("u", "v") := GeostrophicWind(gh.t.w/sqrt(cos(lat*pi/180)),
lon, lat)]
# AAO field
binwidth <- 0.01
ggplot(aao$left, aes(lon, lat)) +
geom_contour_fill(aes(z = gh.t.w/sqrt(cos(lat*pi/180)),
fill = after_stat(level)), binwidth = binwidth,
xwrap = c(0, 360)) +
geom_streamline(aes(dx = dlon(u, lat), dy = dlat(v)),
linewidth = 0.4, L = 80, skip = 3, xwrap = c(0, 360)) +
scale_x_longitude() +
scale_y_latitude(limits = c(-90, -20)) +
scale_fill_divergent_discretised(name = "AAO pattern") +
coord_polar()
```
```{r timeseries}
# AAO signal
ggplot(aao$right, aes(date, gh.t.w)) +
geom_line() +
geom_smooth(span = 0.4)
```
You can read more in the vignettes: [Visualization tools](https://eliocamp.github.io/metR/articles/Visualization-tools.html) and [Working with data](https://eliocamp.github.io/metR/articles/Working-with-data.html).