Learn R Programming

⚠️There's a newer version (0.18.0) of this package.Take me there.

metR

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, 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 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:

install.packages("metR")

Or the development version with:

install.packages("metR", repos = c("https://eliocamp.github.io/metR", getOption("repos")))

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

citation("metR")
#> To cite metR in publications use:
#> 
#> 
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {metR: Tools for Easier Analysis of Meteorological Fields},
#>     author = {Elio Campitelli},
#>     year = {2021},
#>     note = {R package version 0.15.0},
#>     url = {https://eliocamp.github.io/metR/},
#>     doi = {10.5281/zenodo.2593516},
#>   }

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.

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()
#> Warning in .check_wrap_param(list(...)): 'xwrap' and 'ywrap' will be
#> deprecated. Use ggperiodic::periodic insead.

# AAO signal
ggplot(aao$right, aes(date, gh.t.w)) +
    geom_line() +
    geom_smooth(span = 0.4)
#> `geom_smooth()` using method = 'loess' and formula = 'y ~ x'

You can read more in the vignettes: Visualization tools and Working with data.

Copy Link

Version

Install

install.packages('metR')

Monthly Downloads

4,524

Version

0.15.0

License

GPL-3

Maintainer

Elio Campitelli

Last Published

February 9th, 2024

Functions in metR (0.15.0)

MaskLand

Mask
geom_contour2

2d contours of a 3d surface
as.path

Interpolates between locations
geom_contour_fill

Filled 2d contours of a 3d surface
denormalise

Denormalise eof matrices
cut.eof

Remove some principal components.
as.discretised_scale

Create discretised versions of continuous scales
geom_arrow

Arrows
WaveFlux

Calculate wave-activity flux
coriolis

Effects of the Earth's rotation
geom_relief

Relief Shading
scale_label_colour_continuous

Scales for contour label aesthetics
WrapCircular

Wrap periodic data to any range
geom_label_contour

Label contours
geom_streamline

Streamlines
geom_contour_tanaka

Illuminated contours
label_placers

Functions to place contour labels
guide_vector

Reference arrow for magnitude scales
season

Assign seasons to months
is.cross

Cross pattern
guide_colourstrip

Discretized continuous colour guide
geopotential

Geopotential height
scale_mag

Scale for vector magnitudes
spherical

Transform between spherical coordinates and physical coordinates
scale_stroke.colour_continuous

Scale for stroke.colour
temperature

Air temperature
thermodynamics

Thermodynamics
metR

metR: Tools for Easier Analysis of Meteorological Fields
scale_longitude

Helpful scales for maps
scale_divergent

Divergent colour scales
stat_na

Filter only NA values.
standard_atmosphere

Standard atmosphere
reverselog_trans

Reverse log transform
stat_subset

Subset values
waves

Fourier transform functions
logic

Extended logical operators
map_labels

Label longitude and latitude
surface

Surface height
FitLm

Fast estimates of linear regression
GetSMNData

Get Meteorological data
Derivate

Derivate a discrete variable using finite differences
ConvertLongitude

Converts between longitude conventions
EPflux

Computes Eliassen-Palm fluxes.
GetTopography

Get topographic data
EOF

Empirical Orthogonal Function
GeostrophicWind

Calculate geostrophic winds
Anomaly

Anomalies
Impute2D

Impute missing values by linear or constant interpolation
ReadNetCDF

Read NetCDF files.
Percentile

Percentiles
Trajectory

Compute trajectories
MakeBreaks

Functions for making breaks
Smooth2D

Smooths a 2D field
JumpBy

Skip observations
ImputeEOF

Impute missing values
Interpolate

Bilinear interpolation
Mag

Magnitude and angle of a vector