forked from 52North/sos4R
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
130 lines (90 loc) · 4.94 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file!
Also see the README guidelines at https://wiki.52north.org/Documentation/GitHubProjectDocumentation -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
#fig.path = "man/figures/"
)
```
# sos4R
<!-- badges: start -->
[](https://cran.r-project.org/web/checks/check_results_sos4R.html) [](https://travis-ci.org/52North/sos4R)
[](https://ci.appveyor.com/project/52North/sos4R)
[](https://circleci.com/gh/52North/sos4R)
[](https://www.repostatus.org/#active)
[](https://mybinder.org/v2/gh/52North/sos4R/master?urlpath=rstudio)
<!-- badges: end -->
## Description
### R client for OGC SOS
**Easing the access to environmental time series data from an OGC Sensor Observation Service**
sos4R is an extension package of the R environment for statistical computing and visualization.
sos4R is [available on CRAN](https://CRAN.R-project.org/package=sos4R).
The user can use it to query data from standardized SOS instances (with specific consideration of the OGC SOS 2.0 Hydrology Profile) using simple R function calls.
It provides a convenience layer for R users to integrate observation data from SOS servers compliant with the SOS standard without any knowledge about the underlying OGC Sensor Web Enablement standards.
### Features
**Key Technologies**
- R Programming Language
- OGC Sensor Observation Service 2.0
- OGC WaterML 2.0
- OGC Observations and Measurements 2.0
**Benefits**
- Easier access to environmental time series data
- Automatic generation of SOS requests
- Result handling and parsing into standard R objects
- Convenience API: Data Science oriented functions to load data
## Quick start
```{r quickstart, eval = FALSE}
install.packages("sos4R")
library("sos4R")
# connect to SOS and request metadata
mySos <- SOS(url = "http://sensorweb.demo.52north.org/sensorwebtestbed/sos",
binding = "KVP", useDCPs = FALSE, version = "2.0.0")
# retrieve available phenomena and sites
phenomena <- phenomena(sos = mySos, includeSiteId = TRUE, includeTemporalBBox = TRUE)
phenomena
siteList(sos = mySos)
# retrieve data
getData(sos = mySos,
phenomena = phenomena[5,1],
sites = phenomena[5,2],
begin = as.POSIXct("2018-01-01"),
end = as.POSIXct("2018-01-3"))
```
**Install the development version**
You can install the current development version (= the next release for CRAN) directly from GitHub:
```{r install_dev, eval = FALSE}
#install.packages("remotes")
remotes::install_github("52North/sos4R", ref = "dev")
```
## User guide
The project website is at [https://52north.github.io/sos4R](https://52north.github.io/sos4R).
You can also join the chat at [on Gitter](https://gitter.im/52North/sos4R) if you have any questions.
## Demo
sos4R can used to download observation data or build user interfaces for requesting and rendering time series observations.
The screenshot below shows a demo Shiny application, which you can run locally with
```{r demo, eval=FALSE}
shiny::runApp(appDir = file.path(path.package("sos4R"), "shiny"))
```
## Changelog
The latest changes, updates, bug fixes can be found in the package changelog at [https://52north.github.io/sos4R/news/](https://52north.github.io/sos4R/news/).
## References
sos4R is used in the following projects.
- MuDak-WRM, https://www.mudak-wrm.kit.edu/
- NIWA, https://niwa.co.nz/ (NIWA presented the project results at a dedicated [workshop at the FOSS4G SOTM Oceania 2019](https://2019.foss4g-oceania.org/schedule/2019-11-12?sessionId=NNWXKL))
## Credits
- [\@nuest](https://github.com/nuest)
- [\@edzer](https://github.com/edzer)
- [\@BenGraeler](https://github.com/BenGraeler)
- [\@bpross-52n](https://github.com/bpross-52n)
- [\@EHJ-52n](https://github.com/EHJ-52n)
## Contribute
See file `DEV-README.md` for developer documentation or read the developer documentation online at [https://52north.github.io/sos4R/DEV-README.html](https://52north.github.io/sos4R/DEV-README.html).
## License
This R extension package is licensed under [GPL v2.0](https://tldrlegal.com/license/gnu-general-public-license-v2).
Documentation (e.g. vignette) is published under [CC BY 4.0](http://creativecommons.org/licenses/by/4.0/).
sos4R is a project of [52°North Initiative for Geospatial Open Source Software](https://52north.org).