Data

Tools

Indexes

Applications

Experiments

Open Source Science

metR

Tools for Easier Analysis of Meteorological Fields

https://github.com/eliocamp/metr

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (20.0%) to scientific vocabulary

Keywords

atmospheric-science ggplot2 r r-package rstats visualization

Keywords from Contributors

visualisation
Last synced: 6 months ago · JSON representation

Repository

Tools for Easier Analysis of Meteorological Fields

Basic Info
Statistics
  • Stars: 152
  • Watchers: 4
  • Forks: 25
  • Open Issues: 19
  • Releases: 20
Topics
atmospheric-science ggplot2 r r-package rstats visualization
Created over 8 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog

README.Rmd 

---
output: github_document
---



```{r, echo = FALSE}
knitr::opts_chunk$set(
    cache = FALSE,
    collapse = TRUE,
    comment = "#>",
    fig.path = "man/figures/"
)
set.seed(42)
```

# metR 



[![R-CMD-check](https://github.com/eliocamp/metR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/eliocamp/metR/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/eliocamp/metR/graph/badge.svg)](https://app.codecov.io/gh/eliocamp/metR)
[![CRAN status](https://www.r-pkg.org/badges/version/metR)](https://CRAN.R-project.org/package=metR)
[![DOI](https://zenodo.org/badge/96357263.svg)](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).

Owner

  • Name: Elio Campitelli
  • Login: eliocamp
  • Kind: user
  • Location: Melbourne, Australia

Research Fellow at Monash University

GitHub Events

Total
  • Create event: 5
  • Release event: 3
  • Issues event: 17
  • Watch event: 11
  • Delete event: 1
  • Issue comment event: 16
  • Push event: 57
  • Pull request review comment event: 1
  • Pull request review event: 2
  • Pull request event: 5
  • Fork event: 4
Last Year
  • Create event: 5
  • Release event: 3
  • Issues event: 17
  • Watch event: 11
  • Delete event: 1
  • Issue comment event: 16
  • Push event: 57
  • Pull request review comment event: 1
  • Pull request review event: 2
  • Pull request event: 5
  • Fork event: 4

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 1,071
  • Total Committers: 5
  • Avg Commits per committer: 214.2
  • Development Distribution Score (DDS): 0.007
Past Year
  • Commits: 44
  • Committers: 1
  • Avg Commits per committer: 44.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Unknown e****i@g****m 1,063
Teun van den Brand 4****d 5
Paul Murrell p****l@s****z 1
Paola Corrales p****s 1
Matt 3****r 1
Committer Domains (Top 20 + Academic)
stat.auckland.ac.nz: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 188
  • Total pull requests: 22
  • Average time to close issues: 6 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 48
  • Total pull request authors: 7
  • Average comments per issue: 1.07
  • Average comments per pull request: 0.91
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 13
  • Pull requests: 8
  • Average time to close issues: 14 days
  • Average time to close pull requests: 3 days
  • Issue authors: 8
  • Pull request authors: 3
  • Average comments per issue: 0.54
  • Average comments per pull request: 0.63
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • eliocamp (118)
  • paocorrales (6)
  • pascaloettli (5)
  • lemuscanovas (5)
  • fipoucat (4)
  • chrisdane (3)
  • PanfengZhang (3)
  • m-saenger (3)
  • rsbivand (2)
  • yakov116 (1)
  • rmendels (1)
  • jkittner (1)
  • WMueller11 (1)
  • symbalex (1)
  • schckngs (1)
Pull Request Authors
  • eliocamp (10)
  • teunbrand (4)
  • olivroy (4)
  • raymondben (1)
  • m-saenger (1)
  • paocorrales (1)
  • pmur002 (1)
Top Labels
Issue Labels
enhancement (27) bug (11) Derivatives (4) questionable (3) decision (3) reprex needed (1)
Pull Request Labels
hacktoberfest-accepted (1)

Packages

  • Total packages: 4
  • Total downloads:
    • cran 5,384 last-month
  • Total docker downloads: 42,058
  • Total dependent packages: 23
    (may contain duplicates)
  • Total dependent repositories: 31
    (may contain duplicates)
  • Total versions: 73
  • Total maintainers: 1
cran.r-project.org: metR

Tools for Easier Analysis of Meteorological Fields

  • Versions: 22
  • Dependent Packages: 21
  • Dependent Repositories: 31
  • Downloads: 5,384 Last month
  • Docker Downloads: 42,058
Rankings
Stargazers count: 3.1%
Dependent packages count: 3.4%
Forks count: 3.5%
Average: 4.4%
Dependent repos count: 4.8%
Downloads: 7.3%
Maintainers (1)
eliocampitelli@gmail.com
Last synced: 6 months ago
proxy.golang.org: github.com/eliocamp/metR
  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/eliocamp/metr
  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
conda-forge.org: r-metr
  • Versions: 13
  • Dependent Packages: 2
  • Dependent Repositories: 0
Rankings
Dependent packages count: 19.5%
Stargazers count: 28.5%
Average: 29.2%
Dependent repos count: 34.0%
Forks count: 34.7%
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • Formula * imports
  • RCurl * imports
  • checkmate * imports
  • data.table * imports
  • digest * imports
  • fields * imports
  • formula.tools * imports
  • ggplot2 >= 3.0.0 imports
  • grid * imports
  • gtable * imports
  • isoband * imports
  • lubridate * imports
  • memoise * imports
  • plyr * imports
  • purrr * imports
  • scales * imports
  • sp * imports
  • stringr * imports
  • PCICt * suggests
  • covr * suggests
  • gridExtra * suggests
  • here * suggests
  • irlba * suggests
  • knitr * suggests
  • kriging * suggests
  • maps * suggests
  • maptools * suggests
  • ncdf4 * suggests
  • pkgdown * suggests
  • proj4 * suggests
  • raster * suggests
  • reshape2 * suggests
  • rgdal * suggests
  • rmarkdown * suggests
  • testthat >= 2.1.0 suggests
  • udunits2 * suggests
  • vdiffr * suggests
  • viridis * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/pkgdown.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite