Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ropensci/hydroscoper
R interface to the Greek National Data Bank for Hydrometeorological Information
https://github.com/ropensci/hydroscoper
climate greece hydrology hydrometeorology hydroscope meteorological-data meteorological-stations peer-reviewed r r-package rstats tidy-data time-series water-resources
Last synced: 3 months ago
JSON representation
R interface to the Greek National Data Bank for Hydrometeorological Information
- Host: GitHub
- URL: https://github.com/ropensci/hydroscoper
- Owner: ropensci
- License: other
- Created: 2017-12-13T08:33:53.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T04:23:22.000Z (5 months ago)
- Last Synced: 2024-06-11T16:41:27.462Z (5 months ago)
- Topics: climate, greece, hydrology, hydrometeorology, hydroscope, meteorological-data, meteorological-stations, peer-reviewed, r, r-package, rstats, tidy-data, time-series, water-resources
- Language: R
- Homepage: https://docs.ropensci.org/hydroscoper
- Size: 6.13 MB
- Stars: 13
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codemeta: codemeta.json
Awesome Lists containing this project
- open-sustainable-technology - hydroscoper - An R interface to the Greek National Data Bank for Hydrometeorological Information. (Hydrosphere / Freshwater and Hydrology)
README
---
title: hydroscoper
output: github_document
editor_options:
chunk_output_type: inline
---
```{r, echo=FALSE, message=FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
chk_online <- FALSE
# helper function to check if a sub-domain is online
online <- function(url = "kyy.hydroscope.gr") {
# test the http capabilities of the current R build
if (!capabilities(what = "http/ftp")) return(FALSE)
# test connection by trying to read first line of url
test <- try(suppressWarnings(readLines(url, n = 1)), silent = TRUE)
# return FALSE if test inherits 'try-error' class
!inherits(test, "try-error")
}
# check if sub-domains are online
chk_online <- online()
```
[](https://github.com/ropensci/hydroscoper/actions)
[](https://app.codecov.io/gh/ropensci/hydroscoper)
[](https://cran.r-project.org/)
[](https://cran.r-project.org/package=hydroscoper)
[](https://github.com/ropensci/hydroscoper)
[](https://cran.r-project.org/package=hydroscoper)
[](https://github.com/ropensci/software-review/issues/185)
[](https://doi.org/10.5281/zenodo.1196540)
[](https://doi.org/10.21105/joss.00625)
`hydroscoper` is an R interface to the Greek National Data Bank for Hydrological and Meteorological Information,
*Hydroscope*. For more details checkout the package's [website](https://docs.ropensci.org/hydroscoper/) and the vignettes:
* [An introduction to `hydroscoper`](https://docs.ropensci.org/hydroscoper/articles/intro_hydroscoper.html) with details about the Hydroscope project and the package.
* [Using `hydroscoper`'s data sets](https://docs.ropensci.org/hydroscoper/articles/stations_with_data.html) with a simple example of how to use the package's internal data sets.
## Installation
Install the stable release from CRAN with:
```{r cran_installation, eval = FALSE}
install.packages("hydroscoper")
```
You can install the development version from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("ropensci/hydroscoper")
```
## Using hydroscoper
The functions that are provided by `hydroscoper` are:
* `get_stations, get_timeseries, ..., etc.` family functions, to retrieve tibbles with Hydroscope's data for a given data source.
* `get_data`, to retrieve a tibble with time series' values.
* `hydro_coords`, to convert Hydroscope's points' raw format to a tibble.
* `hydro_translate` to translate various terms and names from Greek to English.
The data sets that are provided by `hydroscoper` are:
* `stations` a tibble with stations' data from Hydroscope.
* `timeseries` a tibble with time series' data from Hydroscope.
* `greece_borders` a tibble with the borders of Greece.
## Example
This is a minimal example which shows how to get the station's *200200* precipitation time series *56* from the *kyy* sub-domain.
Load libraries and get data:
```{r load_libraries, eval = chk_online}
library(hydroscoper)
library(tibble)
library(ggplot2)
ts_raw <- get_data(subdomain = "kyy", time_id = 56)
ts_raw
```
Let's create a plot:
```{r plot_time_series, eval = chk_online}
ggplot(data = ts_raw, aes(x = date, y = value))+
geom_line()+
labs(title= "30 min precipitation for station 200200",
x="Date", y = "Rain height (mm)")+
theme_classic()
```
## Meta
* Bug reports, suggestions, and code are welcome. Please see [Contributing](https://github.com/ropensci/hydroscoper/blob/master/CONTRIBUTING.md).
* License:
+ All code is licensed MIT.
+ All data are from the public data sources in `http://www.hydroscope.gr/`.
* To cite `hydroscoper` please use:
```
Vantas Konstantinos, (2018). hydroscoper: R interface to the Greek National Data Bank for
Hydrological and Meteorological Information. Journal of Open Source Software,
3(23), 625 DOI:10.21105/joss.00625
```
or the BibTeX entry:
```
@Article{kvantas2018,
author = {Konstantinos Vantas},
title = {{hydroscoper}: R interface to the Greek National Data Bank for Hydrological and Meteorological Information},
doi = {10.21105/joss.00625},
year = {2018},
month = {mar},
publisher = {The Open Journal},
volume = {2},
number = {23},
journal = {The Journal of Open Source Software}
}
```
[](https://ropensci.org)