hydroscoper

hydroscoper: R interface to the Greek National Data Bank for Hydrological and Meteorological Information - Published in JOSS (2018)

https://github.com/ropensci/hydroscoper

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 9 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org, zenodo.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

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

Last synced: 4 months ago · JSON representation

Repository

R interface to the Greek National Data Bank for Hydrometeorological Information

Basic Info

Host: GitHub
Owner: ropensci
License: other
Language: R
Default Branch: master
Homepage: https://docs.ropensci.org/hydroscoper
Size: 6.51 MB

Statistics

Stars: 14
Watchers: 3
Forks: 1
Open Issues: 0
Releases: 11

Topics

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

Created about 8 years ago · Last pushed 4 months ago

Metadata Files

Readme Changelog Contributing License Codemeta

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

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

JOSS Publication

hydroscoper: R interface to the Greek National Data Bank for Hydrological and Meteorological Information

Published

March 14, 2018

DOI

10.21105/joss.00625

Volume 3, Issue 23, Page 625

Authors

Konstantinos Vantas

Faculty of Engineering, Aristotle University of Thessaloniki, Greece

Editor

Arfon Smith

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "hydroscoper",
  "description": "R interface to the Greek National Data Bank for Hydrological and Meteorological Information. It covers Hydroscope's data sources and provides functions to transliterate, translate and download them into tidy dataframes.",
  "name": "hydroscoper: Interface to the Greek National Data Bank for Hydrometeorological Information",
  "relatedLink": "https://docs.ropensci.org/hydroscoper/",
  "codeRepository": "https://github.com/ropensci/hydroscoper",
  "issueTracker": "https://github.com/ropensci/hydroscoper/issues             ",
  "license": "https://spdx.org/licenses/MIT",
  "version": "1.7.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.0 (2025-04-11)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Konstantinos",
      "familyName": "Vantas",
      "email": "kon.vantas@gmail.com",
      "@id": "https://orcid.org/0000-0001-6387-8791"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Sharla",
      "familyName": "Gelfand"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Konstantinos",
      "familyName": "Vantas",
      "email": "kon.vantas@gmail.com",
      "@id": "https://orcid.org/0000-0001-6387-8791"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "ggplot2",
      "name": "ggplot2",
      "version": ">= 3.5",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "version": ">= 1.45",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "version": ">= 2.25",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "httptest",
      "name": "httptest",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httptest"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.4"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "stringi",
      "name": "stringi",
      "version": ">= 1.8",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=stringi"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "stringr",
      "name": "stringr",
      "version": ">= 1.5",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=stringr"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "tibble",
      "name": "tibble",
      "version": ">= 3.2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tibble"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "readr",
      "name": "readr",
      "version": ">= 2.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=readr"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "version": ">= 1.8",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jsonlite"
    },
    "SystemRequirements": null
  },
  "fileSize": "507.75KB",
  "citation": [
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2018",
      "author": [
        {
          "@type": "Person",
          "givenName": "Konstantinos",
          "familyName": "Vantas"
        }
      ],
      "name": "{hydroscoper}: R interface to the Greek National Data Bank for Hydrological and Meteorological Information",
      "identifier": "10.21105/joss.00625",
      "@id": "https://doi.org/10.21105/joss.00625",
      "sameAs": "https://doi.org/10.21105/joss.00625",
      "isPartOf": {
        "@type": "PublicationIssue",
        "issueNumber": "23",
        "datePublished": "2018",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "2",
          "name": "The Journal of Open Source Software"
        }
      }
    }
  ],
  "releaseNotes": "https://github.com/ropensci/hydroscoper/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/hydroscoper/blob/master/README.md",
  "contIntegration": [
    "https://app.travis-ci.com/ropensci/hydroscoper",
    "https://ci.appveyor.com/project/ropensci/hydroscoper",
    "https://app.codecov.io/gh/ropensci/hydroscoper"
  ],
  "review": {
    "@type": "Review",
    "url": "https://github.com/ropensci/software-review/issues/185",
    "provider": "https://ropensci.org"
  },
  "keywords": [
    "climate",
    "hydroscope",
    "hydrometeorology",
    "hydrology",
    "tidy-data",
    "time-series",
    "greece",
    "water-resources",
    "meteorological-stations",
    "meteorological-data",
    "r",
    "rstats",
    "r-package",
    "peer-reviewed"
  ]
}

GitHub Events

Total

Watch event: 1
Push event: 275

Last Year

Watch event: 1
Push event: 275

Committers

Last synced: 5 months ago

All Time

Total Commits: 308
Total Committers: 4
Avg Commits per committer: 77.0
Development Distribution Score (DDS): 0.373

Past Year

Commits: 8
Committers: 1
Avg Commits per committer: 8.0
Development Distribution Score (DDS): 0.0

Top Committers

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

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 16
Total pull requests: 1
Average time to close issues: 28 days
Average time to close pull requests: about 14 hours
Total issue authors: 3
Total pull request authors: 1
Average comments per issue: 0.25
Average comments per pull request: 2.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

kvantas (14)
maelle (1)
jeroen (1)

Pull Request Authors

sharlagelfand (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads: unknown
Total docker downloads: 130,623

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 8

cran.r-project.org: hydroscoper

Interface to the Greek National Data Bank for Hydrometeorological Information

Homepage: https://github.com/ropensci/hydroscoper
Documentation: http://cran.r-project.org/web/packages/hydroscoper/hydroscoper.pdf
License: MIT + file LICENSE
Status: removed
Latest release: 1.4.1
published over 4 years ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 0
Docker Downloads: 130,623

Rankings

Stargazers count: 16.3%

Forks count: 21.9%

Average: 25.8%

Dependent packages count: 29.8%

Dependent repos count: 35.5%

Last synced: 4 months ago

Dependencies

DESCRIPTION cran

R >= 3.4 depends
jsonlite >= 1.7 imports
pingr >= 2.0 imports
readr >= 1.4 imports
stringi >= 1.5 imports
stringr >= 1.4 imports
tibble >= 3.1 imports
ggplot2 >= 3.3 suggests
knitr >= 1.31 suggests
rmarkdown >= 2.7 suggests
testthat >= 3.0 suggests

.github/workflows/tic.yml actions

actions/cache/restore v3 composite
actions/cache/save v3 composite
actions/checkout v4 composite
actions/upload-artifact v4 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-tinytex v2 composite

.github/workflows/update-tic.yml actions

actions/checkout v4 composite
peter-evans/create-pull-request v4 composite
r-lib/actions/setup-r v2 composite

hydroscoper

Science Score: 93.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.Rmd

Owner

JOSS Publication

hydroscoper: R interface to the Greek National Data Bank for Hydrological and Meteorological Information

Authors

Editor

Tags

CodeMeta (codemeta.json)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: hydroscoper

Rankings

Dependencies