https://github.com/tobiste/geoprofiler
Creates Swath profiles and Distance vs X plots by measuring the accurate distances parallel and perpendicular to user-defined lines
https://github.com/tobiste/geoprofiler
crosssections earth-science geology geomorphology geoscience plotting terrain-analysis transects
Last synced: 7 days ago
JSON representation
Creates Swath profiles and Distance vs X plots by measuring the accurate distances parallel and perpendicular to user-defined lines
- Host: GitHub
- URL: https://github.com/tobiste/geoprofiler
- Owner: tobiste
- License: gpl-3.0
- Created: 2024-12-03T15:02:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-18T18:57:38.000Z (about 1 month ago)
- Last Synced: 2026-01-19T02:52:31.100Z (about 1 month ago)
- Topics: crosssections, earth-science, geology, geomorphology, geoscience, plotting, terrain-analysis, transects
- Language: R
- Homepage: https://tobiste.github.io/geoprofiler/
- Size: 8.18 MB
- Stars: 0
- 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 = "100%"
)
```
# geoprofiler
[](https://cran.r-project.org/package=geoprofiler)
[](https://cran.r-project.org/package=geoprofiler)
[](https://github.com/tobiste/geoprofiler/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/tobiste/geoprofiler?branch=main)
The goal of `{geoprofiler}` is to get distances along and across user-defined
profile lines or transects. This is useful to visualize the distance-dependency
of some variables in the geosciences.
The concept of `{geoprofiler}` is a coordinate transformation of your
geo-coordinates into "profile coordinates". These coordinates are the
distances along and across your profile.
## Installation
You must have R installed on your system (see ).
To install `{geoprofiler}` from CRAN, type the following code at the R
command line prompt:
```
install.packages("geoprofiler")
```
The most recent development version of `{geoprofiler}` is available from
from [GitHub](https://github.com/) and can be installed on your system as follows:
``` r
# install.packages("devtools")
devtools::install_github("tobiste/geoprofiler")
```
## Example
This is a basic example which shows you how to create a profile.
```{r example}
library(geoprofiler)
library(ggplot2)
```
Import example data and transfer them into a `sf` object:
```{r quakes}
data(quakes)
quakes_sf <- sf::st_as_sf(quakes, coords = c("long", "lat"), crs = "WGS84")
```
Create a profile line from two known points:
```{r profile}
profile <- data.frame(lon = c(160, -170), lat = c(-15, -30)) |>
sf::st_as_sf(coords = c("lon", "lat"), crs = "WGS84") |>
sf::st_shift_longitude() |>
profile_line()
```
> Note: You can also create a profile line by a direction via `profile_points()`
Calculate the distances of all points along and across the profile line:
```{r cooridnates}
quakes_profile <- profile_coords(quakes_sf, profile = profile) |>
dplyr::bind_cols(quakes_sf)
```
Finally, create your profile plot:
```{r plot}
ggplot(quakes_profile, aes(X, depth, color = mag, size = abs(Y), alpha = abs(Y))) +
geom_point() +
scale_color_viridis_c("Richter magnitude", option = "A") +
scale_size_continuous(bquote("Distance from profile (" * degree * ")"), range = c(3, .1)) +
scale_alpha_continuous(bquote("Distance from profile (" * degree * ")"), range = c(1, .1)) +
scale_y_reverse() +
scale_x_continuous(guide = guide_axis(position = "top")) +
labs(x = bquote("Distance along profile (" * degree * ")"), y = "Depth (km)") +
theme_classic()
```
The above example uses the `quakes` dataset giving the locations of 1000 seismic
events of MB \> 4.0. The events occurred in a cube near Fiji since 1964.
## Documentation
The detailed documentation can be found at
## Author
Tobias Stephan ([tstephan\@lakeheadu.ca](mailto:tstephan@lakeheadu.ca){.email})
## Feedback, issues, and contributions
I welcome feedback, suggestions, issues, and contributions! If you have found a
bug, please file it [here](https://github.com/tobiste/geoprofiler/issues) with
minimal code to reproduce the issue.
## How to cite geoprofiler
When referencing this package, please cite the package DOI:
[10.32614/CRAN.package.geoprofiler](https://doi.org/10.32614/CRAN.package.geoprofiler).
## License
GPL-3.0 License