getRad/README.Rmd at main · aloftdata/getRad · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  warning = FALSE,
  message = FALSE
)
```

# getRad

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/getRad)](https://CRAN.R-project.org/package=getRad)
[![R-CMD-check](https://github.com/aloftdata/getRad/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/aloftdata/getRad/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/aloftdata/getRad/branch/main/graph/badge.svg)](https://app.codecov.io/gh/aloftdata/getRad/)
[![repo status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![regular-checks](https://github.com/aloftdata/getRad/actions/workflows/regular-checks.yaml/badge.svg)](https://github.com/aloftdata/getRad/actions/workflows/regular-checks.yaml)
<!-- badges: end -->

getRad is an R package that provides a unified interface to download radar data for biological and aeroecological research. It gives access to both polar volume radar data and [vertical profile data](https://aloftdata.eu/vpts-csv/) from [different sources](https://aloftdata.github.io/getRad/articles/supported_sources.html) and loads it directly into R. getRad also facilitates further exploration of the data by other tools such as [bioRad](https://adriaandokter.com/bioRad/) by standardizing the data.

## Installation

Install the released version of getRad from CRAN:

``` r
install.packages("getRad")
```

Or install the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("aloftdata/getRad")
```

## Usage

Download a polar volume, and then plot it using `bioRad`:

```{r example}
library(getRad)
library(bioRad)

# Plot daytime insect movements in Finland (Mäkinen et al. 2022)
pvol <- get_pvol("fianj", as.POSIXct("2012-05-17 14:00", tz = "UTC"))
plot(project_as_ppi(get_scan(pvol, 0), range_max = 75000))
plot(calculate_vp(pvol, h_layer = 50, n_layer = 40, warning = FALSE))

# Plot nocturnal migration in Finland
pvol <- get_pvol("fianj", as.POSIXct("2012-05-11 23:00", tz = "UTC"))
plot(project_as_ppi(get_scan(pvol, 0), range_max = 75000))
plot(calculate_vp(pvol, h_layer = 50, n_layer = 40, warning = FALSE))
```

Download a vertical profile time series from the [Aloft bucket](https://aloftdata.eu/browse/):

```{r vpts}
# Plot VPTS data for two radars
vpts_list <- get_vpts(
  radar = c("bejab", "deess"),
  datetime = lubridate::interval(
    lubridate::as_datetime("2021-10-03 16:00:00"),
    lubridate::as_datetime("2021-10-05 10:00:00")
  ),
  source = "baltrad"
)
par(mfrow = 2:1)
for (i in names(vpts_list)) {
  plot(regularize_vpts(vpts_list[[i]]), main = i)
}
```

## Meta

- We welcome [contributions](https://aloftdata.github.io/getRad/CONTRIBUTING.html) including bug reports.
- License: MIT
- Get citation information for getRad in R with `citation("getRad")`.
- Please note that this project is released with a [Contributor Code of Conduct](https://aloftdata.github.io/getRad/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.