-
Notifications
You must be signed in to change notification settings - Fork 32
/
Copy pathREADME.Rmd
187 lines (142 loc) · 6.89 KB
/
README.Rmd
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
```{r packages, message=FALSE, warning=FALSE, include=FALSE}
library(stationaRy)
library(tidyverse)
library(lubridate)
```
# stationaRy <a href='http://rich-iannone.github.io/stationaRy/'><img src="man/figures/logo.svg" align="right" height="250px" /></a>
[](https://CRAN.R-project.org/package=stationaRy)
[](https://github.com/rich-iannone/stationaRy/actions)
[](https://codecov.io/gh/rich-iannone/stationaRy?branch=master)
## Overview
Get meteorological data from met stations located all over the world. That's what you can do with this **R** package. There are *LOTS* of stations too (29,729 available in this dataset) and many have data that go pretty far back in time. The data comes from the Integrated Surface Dataset (ISD), which is maintained by the National Oceanic and Atmospheric Administration (NOAA).
### Retrieving Met Data with a `station_id`
Let's get some met data from La Guardia Airport in New York City (the station ID value is `"725030-14732"`). This station has a pretty long history (starting operations in 1973) but we'll just obtain data from the years of 2017 and 2018.
```{r get_met_data, echo=TRUE, results="hide"}
lga_met_data <-
get_met_data(
station_id = "725030-14732",
years = 2017:2018
)
```
```{r lga_met_data}
lga_met_data
```
### Discovering Met Stations
At a minimum we need a station's identifier to obtain its met data. We can start the process of getting an identifier by accessing the entire catalog of station metadata with the `get_station_metadata()` function. The output tibble has station `id` values in the first column. Let's get a subset of stations from that: those stations that are located in Norway.
```{r stations_norway}
stations_norway <-
get_station_metadata() %>%
dplyr::filter(country == "NO")
stations_norway
```
This table can be even more greatly reduced to isolate the stations of interest. For example, we could elect to get only high-altitude stations (above 1000 meters) in Norway.
```{r norway_high_elev}
norway_high_elev <-
stations_norway %>%
dplyr::filter(elev > 1000)
norway_high_elev
```
The station IDs from the tibble can be transformed into a vector of station IDs with `dplyr::pull()`.
```{r norway_high_elev_ids}
norway_high_elev %>% dplyr::pull(id)
```
Suppose you'd like to collect several years of met data from a particular station and fetch only the observations that meet some set of conditions. Here's an example of obtaining temperatures above 15 degrees Celsius from the high-altitude `"JUVVASSHOE"` station in Norway and adding a column with temperatures in degrees Fahrenheit.
```{r echo=TRUE, results="hide"}
station_data <-
get_station_metadata() %>%
dplyr::filter(name == "JUVVASSHOE") %>%
dplyr::pull(id) %>%
get_met_data(years = 2011:2019)
high_temp_data <-
station_data %>%
dplyr::select(id, time, wd, ws, temp) %>%
dplyr::filter(temp > 16) %>%
dplyr::mutate(temp_f = ((temp * (9/5)) + 32) %>% round(1)) %>%
dplyr::arrange(dplyr::desc(temp_f))
```
```{r high_temp_data}
high_temp_data
```
### Additional Data Fields
There can be a substantial amount of additional met data beyond wind speed, ambient temperature, etc. However, these additional fields can vary greatly across stations. The nomenclature for the additional categories of data uses 'two-letter + digit' identifiers (e.g., `AA1`, `GA1`, etc.). Within each category are numerous fields, where the variables are coded as `[identifer]_[index]`). More information about these additional data fields can be found in [this PDF document](http://www1.ncdc.noaa.gov/pub/data/ish/ish-format-document.pdf).
To find out which categories of additional data fields are available for a station, we can use the `station_coverage()` function. You'll get a tibble with the available additional categories and their counts over the specified period.
```{r echo=TRUE, results="hide"}
additional_data_fields <-
get_station_metadata() %>%
dplyr::filter(name == "JUVVASSHOE") %>%
dplyr::pull(id) %>%
station_coverage(years = 2015)
```
```{r additional_data_fields}
additional_data_fields
```
We can use **purrr**'s `map_df()` function to get additional data field coverage for a subset of stations (those that are near sea level and have data in 2019). With the `station_coverage()` function set to output tibbles in `wide` mode (one row per station, field categories as columns, and counts of observations as values), we can ascertain which stations have the particular fields we need.
```{r many_stations_fields, echo=TRUE, results="hide"}
stns <-
get_station_metadata() %>%
dplyr::filter(country == "NO", elev <= 5 & end_year == 2019)
coverage_tbl <-
purrr::map_df(
seq(nrow(stns)),
function(x) {
stns %>%
dplyr::pull(id) %>%
.[[x]] %>%
station_coverage(
years = 2019,
wide_tbl = TRUE
)
}
)
```
```{r coverage_tbl}
coverage_tbl
```
For the `"KAWAIHAE"` station in Hawaii, some interesting data fields are available. In particular, its `SA1` category provides sea surface temperature data, where the `sa1_1` and `sa1_2` variables represent the sea surface temperature and its quality code.
Combining the use of `get_met_data()` with functions from **dplyr**, we can create a table of the mean ambient and sea-surface temperatures by month. The additional data is included in the met data table by using the `add_fields` argument and specifying the `"SA1"` category (multiple categories can be included).
```{r sa1_field, echo=TRUE, results="hide"}
kawaihae_sst <-
get_met_data(
station_id = "997173-99999",
years = 2017:2018,
add_fields = "SA1"
) %>%
dplyr::mutate(
year = lubridate::year(time),
month = lubridate::month(time)
) %>%
dplyr::filter(sa1_2 == 1) %>%
dplyr::group_by(year, month) %>%
dplyr::summarize(
avg_temp = mean(temp, na.rm = TRUE),
avg_sst = mean(sa1_1, na.rm = TRUE)
)
```
```{r kawaihae_sst}
kawaihae_sst
```
## Installation
The **stationaRy** package can be easily installed from CRAN.
```{r install_cran, eval=FALSE}
install.packages("stationaRy")
```
To install the development version of **stationaRy**, use the following:
```{r install_github, eval=FALSE}
install.packages("devtools")
remotes::install_github("rich-iannone/stationaRy")
```
If you encounter a bug, have usage questions, or want to share ideas to make this package better, feel free to file an [issue](https://github.com/rich-iannone/stationaRy/issues).
## License
MIT © Richard Iannone