-
Notifications
You must be signed in to change notification settings - Fork 9
/
README.Rmd
142 lines (103 loc) · 6.95 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
---
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%"
)
```
# {weatherOz}: An API Client for Australian Weather and Climate Data Resources <img src="man/figures/logo.png" align="right"/>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#stable) [](https://zenodo.org/badge/latestdoi/613750527) [](https://github.com/ropensci/software-review/issues/598) [](https://joss.theoj.org/papers/10.21105/joss.06717)
[](https://github.com/ropensci/weatherOz/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/ropensci/weatherOz)
[](https://CRAN.R-project.org/package=weatherOz)
<!-- badges: end -->
{weatherOz} facilitates access to and download of weather and climate data for Australia from Australian data sources.
Data are sourced from from the [Western Australia Department of Primary Industries and Regional Development (DPIRD)](https://www.agric.wa.gov.au/weather-api-20) and the [Scientific Information for Land Owners (SILO) API](https://www.agric.wa.gov.au/weather-api-20) endpoints and the Australian Government Bureau of Meteorology’s (BOM) [FTP server](http://www.bom.gov.au/catalogue/anon-ftp.shtml).
The package queries the APIs or an FTP server and returns data as a data frame or radar and satellite imagery in your R session.
Observation data from DPIRD's weather station network are available via the [Weather 2.0](https://www.agric.wa.gov.au/weather-api-20) Open API initiative.
SILO data is available from Queensland's Long Paddock initiative (Jeffery *et al.* 2001) and are spatially and temporally complete, covering all Australia and few nearby islands (112 to 154 degrees longitude, -10 to -44 degrees latitude), with resolution 0.05° longitude by 0.05° latitude (approximately 5 km × 5 km).
Visit the [SILO website](https://www.longpaddock.qld.gov.au/silo/) for more details about how the data is prepared and which climate data are available.
Agriculture bulletins, radar imagery, satellite imagery and seven-day forecasts are available from the Bureau of Meteorology (BOM) via an anonymous FTP server.
Access to DPIRD API requires an API key.
Apply for an API key by submitting the [DPIRD API registration form](https://www.agric.wa.gov.au/form/dpird-api-registration).
Access to the SILO API is conditioned to supplying a valid email address with the user query.
Follow the API Terms and Conditions for the [DPIRD](https://www.agric.wa.gov.au/apis/api-terms-and-conditions) and [SILO](https://www.longpaddock.qld.gov.au/silo/api-documentation/) APIs.
Observation data from the DPIRD's weather station network is also available via a [web interface](https://weather.agric.wa.gov.au).
The data available is a mirror of the DPIRD Weather 2.0 API endpoints.
Rainfall estimates are also available at virtual stations (*i.e.*, where no observational data is present) and is sourced from the Doppler radar service provided by the Australian Government Bureau of Meteorology (BOM) under license.
## Installation instructions
You can install the stable version of {weatherOz} from [CRAN](https://cran.r-project.org/) like so:
``` r
install.packages("weatherOz")
```
You can install the development version of {weatherOz} like so:
``` r
install.packages("weatherOz", repos = "https://ropensci.r-universe.dev")
```
## A Note on API Keys
The examples in this README assume that you have stored your API key in your .Renviron file.
{weatherOz} will prompt you to set up your API keys automatically if you haven't.
For more information on the preferred method for setting up your API keys, see [Chapter 8](https://rstats.wtf/r-startup.html#renviron) in "What They Forgot to Teach You About R" by Bryan *et al.* for more on storing details in your .Renviron if you are unfamiliar.
To get a DPIRD API key, you can use `get_key()` and it will direct you to the form to request a key and provides instructions for setting it up so that it's available in your R session and {weatherOz} will automatically find it.
If you have already set up an API key, this will return that value for you.
```{r get-dpird-key, eval=FALSE}
get_key(service = "DPIRD")
```
You only need to provide an e-mail address for the SILO API.
Using `get_key()` will provide you with instructions on what format to use in your .Renviron so that {weatherOz} will auto-recognise it and if you have already set up an API key, this will return that value for you.
```{r get-silo-key, eval=FALSE}
get_key(service = "SILO")
```
Note that you do not need to do this separately, any function requiring an API key will prompt you if you don't have one set.
## Example 1
Source wind and erosion conditions for daily time interval from the DPIRD Weather 2.0 API.
```{r summaries, message=FALSE}
library(weatherOz)
wd <- get_dpird_summaries(
station_code = "BI",
start_date = "20220501",
end_date = "20220502",
interval = "daily",
values = c(
"wind",
"erosionCondition",
"erosionConditionMinutes",
"erosionConditionStartTime"
)
)
wd
```
## Example 2
Source data from latitude and longitude coordinates anywhere in Australia (interpolated/gridded data - SILO API) for Southwood, QLD for max and min temperature and rainfall.
```{r data_drill}
library(weatherOz)
wd <- get_data_drill(
latitude = -27.85,
longitude = 150.05,
start_date = "20221001",
end_date = "20221201",
values = c(
"max_temp",
"min_temp",
"rain"
)
)
head(wd)
```
## Notes on Data and API Endpoints
Note that most of the data are not static and may be replaced with improved data.
Also please note that SILO may be unavailable between 11am and 1pm (Brisbane time) each Wednesday and Thursday to allow for essential system maintenance.
Please also note that not all exposed endpoints of the DPIRD APIs have associated functions.
Development is ongoing.
While we are responsive to user requests, we don't make any commitments about speed of delivery.
## References
Jeffrey, S.J., Carter, J.O., Moodie, K.B. and Beswick, A.R. (2001). Using spatial interpolation to construct a comprehensive archive of Australian climate data, _Environmental Modelling and Software_, Vol 16/4, pp 309-330. <https://doi.org/10.1016/S1364-8152(01)00008-1>.
## Code of Conduct
Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/).
By contributing to this project, you agree to abide by its terms.