This repository has been archived by the owner on Oct 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #172 from nuest/master
Bugfix release
- Loading branch information
Showing
80 changed files
with
660 additions
and
474 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,3 +34,7 @@ vignettes/sos4R.toc | |
| cache/ | ||
| \.vscode/ | ||
| revdep/ | ||
|
|
||
| vignettes/figure/ | ||
|
|
||
| vignettes/sos4R-vignette-10-egu-2020.log | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,8 @@ | |
| output: github_document | ||
| --- | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
| <!-- 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( | ||
|
|
@@ -12,9 +13,7 @@ knitr::opts_chunk$set( | |
| ) | ||
| ``` | ||
|
|
||
| # sos4R - R client for OGC SOS | ||
|
|
||
| sos4R is an extension for the R environment for statistical computing and visualization. It allows to query data from standard conform SOS instances using simple R function calls and does no require any knowledge about the Sensor Web. It is easily extendible for new data models and opens the huge amount of analysis and visualization features of the R environment for the Sensor Web. | ||
| # sos4R | ||
|
|
||
| <!-- badges: start --> | ||
| [](https://cran.r-project.org/web/checks/check_results_sos4R.html) [](https://travis-ci.org/52North/sos4R) | ||
|
|
@@ -24,54 +23,108 @@ sos4R is an extension for the R environment for statistical computing and visual | |
| [](https://mybinder.org/v2/gh/52North/sos4R/master?urlpath=rstudio) | ||
| <!-- badges: end --> | ||
|
|
||
| ## Documentation & Links | ||
| ## 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. | ||
|
|
||
| - **Website**: https://52north.github.io/sos4R | ||
| - CRAN: https://CRAN.R-project.org/package=sos4R | ||
| - Source code: https://github.com/52North/sos4R | ||
| - **Support**: [](https://gitter.im/52North/sos4R) | ||
| - **Developer documentation:** https://52north.github.io/sos4R/DEV-README.html | ||
| - Open Hub: <https://www.openhub.net/p/sos4R> | ||
| ### Features | ||
|
|
||
| ## Development | ||
| **Key Technologies** | ||
|
|
||
| [](https://travis-ci.org/52North/sos4R) | ||
| [](https://ci.appveyor.com/project/52North/sos4R) | ||
| - R Programming Language | ||
| - OGC Sensor Observation Service 2.0 | ||
| - OGC WaterML 2.0 | ||
| - OGC Observations and Measurements 2.0 | ||
|
|
||
| sos4R is developed on GitHub using the [fork & pull development model](https://help.github.com/articles/using-pull-requests/#fork--pull). | ||
| The [main repository's issue tracker](https://github.com/52North/sos4R/issues) is used to coordinate development. | ||
| **Benefits** | ||
|
|
||
| The `master` branch represents the current version that is [published on CRAN](https://CRAN.R-project.org/package=sos4R), the `dev` branch is the current development version. | ||
| - 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 | ||
|
|
||
| See file `DEV-README.md` for developer documentation. | ||
| ## Quick start | ||
|
|
||
| ### Install the development version | ||
| ```{r quickstart, eval = FALSE} | ||
| install.packages("sos4R") | ||
| library("sos4R") | ||
| You can install the current development version (= the next release for CRAN) directly from GitHub with the following commands. | ||
| # 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")) | ||
| ``` | ||
|
|
||
| ```{r, eval = FALSE} | ||
| **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") | ||
| ``` | ||
|
|
||
| ### Contributors | ||
| ## 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 observatoins. | ||
| 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) | ||
|
|
||
| sos4R is a project of [52°North Initiative for Geospatial Open Source Software](https://52north.org). | ||
|
|
||
| [](https://52north.org) | ||
| ## Contribute | ||
|
|
||
| ### Contact | ||
|
|
||
| Do you have a question that is not answered in the links above? Contact Daniel: [[email protected]]([email protected]) | ||
| 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). | ||
Oops, something went wrong.