https://github.com/pepijn-devries/ggfields
Add vector fields layers to ggplots
https://github.com/pepijn-devries/ggfields
ggplot2 spatial visualisation
Last synced: 4 months ago
JSON representation
Add vector fields layers to ggplots
- Host: GitHub
- URL: https://github.com/pepijn-devries/ggfields
- Owner: pepijn-devries
- License: gpl-3.0
- Created: 2024-01-20T13:12:11.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-09-05T17:07:44.000Z (9 months ago)
- Last Synced: 2026-01-11T15:41:09.135Z (5 months ago)
- Topics: ggplot2, spatial, visualisation
- Language: R
- Homepage: https://pepijn-devries.github.io/ggfields/
- Size: 9.1 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "70%",
fig.ext = "svg",
dev = "ggsave"
)
```
# ggfields
## Overview
[](https://github.com/pepijn-devries/ggfields/actions/workflows/R-CMD-check.yaml)
[](https://CRAN.R-project.org/package=ggfields)
[](https://cran.r-project.org/web/checks/check_results_ggfields.html)
[](https://pepijn-devries.r-universe.dev/ggfields)
[](https://app.codecov.io/gh/pepijn-devries/ggfields)
Add vector field layers to your `ggplot2::ggplot()`. Although it has similarities
with `ggplot2::geom_spoke()`, `ggfields` offers some distinct features:
* The `radius` aesthetic is mapped to a scale and therefore can be added
to the guides (see `vignette("radius_aes")`).
* Not only `data.frame`s are supported, but also geometric data
(`sf::st_sf()` and `stars::st_as_stars()`).
* Corrects angles for displayed aspect ratio or coordinate system
(see `vignette("angle_correction")`).
## Installation
> Get CRAN version
```{r eval=FALSE}
install.packages("ggfields")
```
> Get development version from r-universe
```{r eval=FALSE}
install.packages("ggfields", repos = c("https://pepijn-devries.r-universe.dev", "https://cloud.r-project.org"))
```
## Adding vector fields to a map
The example below shows how seawater current data can be added to a map:
```{r init, results = 'hide', message = FALSE}
library(ggplot2)
library(ggfields)
library(ggspatial) ## For annotating with Open Street Map
```
```{r theme, echo = FALSE}
theme_set(theme_light())
set.seed(0)
```
```{r map, results = 'hide', message = FALSE, fig.width = 5, fig.height = 7, out.width = "50%"}
data(seawatervelocity)
ggplot() +
ggspatial::annotation_map_tile(
alpha = 0.25,
cachedir = tempdir()) +
geom_fields(
data = seawatervelocity,
aes(radius = as.numeric(v),
angle = as.numeric(angle),
colour = as.numeric(v)),
max_radius = grid::unit(0.7, "cm")) +
labs(colour = "v[m/s]",
radius = "v[m/s]") +
scale_radius_binned() +
scale_colour_viridis_b(guide = guide_bins())
```
## Simple data.frames
Vector arrows can also be added to simple plots with `x` and `y` data:
```{r dataframe, results = 'hide', message = FALSE}
## First generate some arbitrary data to plot:
n <- 10
df <- data.frame(x = seq(0, 100, length.out = n), y = rnorm(n),
ang = seq(0, 2*pi, length.out = n))
df$len <- 2 + df$y + rnorm(n)/4
ggplot(df, aes(x = x, y = y)) +
geom_line() +
geom_fields(aes(angle = ang, radius = len), .angle_correction = NULL)
```