hydroscoper

An R interface to the Greek National Data Bank for Hydrometeorological Information.
https://github.com/ropensci/hydroscoper

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

climate greece hydrology hydrometeorology hydroscope meteorological-data meteorological-stations peer-reviewed r r-package rstats tidy-data time-series water-resources

Keywords from Contributors

precipitation climate-data routes genome topic-modeling

Last synced: about 23 hours ago
JSON representation

Repository metadata

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 (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-04-22T04:23:34.000Z (5 days ago)
• Last Synced: 2025-04-22T06:17:47.386Z (5 days 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.53 MB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Releases: 11
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codemeta: codemeta.json

README.Rmd

          ---
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()

```
[![tic](https://github.com/ropensci/hydroscoper/workflows/tic/badge.svg?branch=master)](https://github.com/ropensci/hydroscoper/actions)
[![codecov](https://codecov.io/github/ropensci/hydroscoper/branch/master/graphs/badge.svg)](https://app.codecov.io/gh/ropensci/hydroscoper) 
[![minimal R version](https://img.shields.io/badge/R%3E%3D-3.4-6666ff.svg)](https://cran.r-project.org/)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/hydroscoper)](https://cran.r-project.org/package=hydroscoper)
[![packageversion](https://img.shields.io/badge/Package%20version-1.7.0-orange.svg?style=flat-square)](https://github.com/ropensci/hydroscoper)
[![](https://cranlogs.r-pkg.org/badges/grand-total/hydroscoper)](https://cran.r-project.org/package=hydroscoper)
[![ropensci](https://badges.ropensci.org/185_status.svg)](https://github.com/ropensci/software-review/issues/185)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1196540.svg)](https://doi.org/10.5281/zenodo.1196540)
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00625/status.svg)](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}
}
```

[![ropensci_footer](http://ropensci.org/public_images/github_footer.png)](https://ropensci.org)

        

---

Owner metadata

• Name: rOpenSci
• Login: ropensci
• Email: [email protected]
• Kind: organization
• Description:
• Website: https://ropensci.org/
• Location: Berkeley, CA
• Twitter: rOpenSci
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1200269?v=4
• Repositories: 307
• Last ynced at: 2023-03-10T20:30:59.242Z
• Profile URL: https://github.com/ropensci

---

GitHub Events

Total

• Watch event: 1
• Push event: 183

Last Year

• Watch event: 1
• Push event: 183

---

Committers metadata

Last synced: 6 days ago

Name	Email	Commits
=	=	193
Konstantinos Vantas	k****s@g****m	106
Jeroen Ooms	j****s@g****m	1
Sharla Gelfand	s****d@g****m	1

Committer domains:

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ropensci/hydroscoper

---

---

---

Package metadata

• Total packages: 1
• Total downloads: unknown
• Total docker downloads: 130,623
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 8

---

Dependencies

Score: 15.805460558679814