hubeau

R package for downloading data from the French Hub'Eau APIs: https://hubeau.eaufrance.fr/

https://github.com/inrae/hubeau

Science Score: 39.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 3 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

R package for downloading data from the French Hub'Eau APIs: https://hubeau.eaufrance.fr/

Basic Info
Statistics
  • Stars: 12
  • Watchers: 6
  • Forks: 6
  • Open Issues: 5
  • Releases: 6
Created almost 5 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License

README.Rmd

---
output: github_document
---



```{r opts, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# hubeau an R package for the Hub'Eau APIs




[![CRAN](https://www.r-pkg.org/badges/version-ago/hubeau)](https://cran.r-project.org/package=hubeau)
[![Total downloads](https://cranlogs.r-pkg.org/badges/grand-total/hubeau)](https://cran.r-project.org/package=hubeau)
[![DOI: 10.57745/XKN6NC](https://img.shields.io/badge/doi-10.57745%2FXKN6NC-purple)](https://doi.org/10.57745/XKN6NC)
`r badger::badge_license(color = "orange")`
`r badger::badge_lifecycle("stable", color = "blue")`

[![R-CMD-check](https://github.com/inrae/hubeau/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/inrae/hubeau/actions/workflows/R-CMD-check.yaml)


'hubeau' is an R-package proposing a collection of function to help retrieve data from the French national databases on water: https://hubeau.eaufrance.fr

# Installation

``` r
# Install released version from CRAN
install.packages("hubeau")

# Install development version from GitHub:
# install.packages("remotes")
remotes::install_github("inrae/hubeau")
```

# Loading library

```{r library}
library(hubeau)
```

# Get started

```{r import_documentationchild, results='asis', echo=FALSE}
convert_link <- function(s) {
  m <- gregexpr("\\[.*\\(\\)\\]", s)
  if (m[[1]][1] == -1) return(s)
  x <- regmatches(s, m)
  x <- gsub("\\[|\\(|\\)|\\]", "", x)
  x2 <- strsplit(x, "_", fixed = TRUE)[[1]]
  x2 <- paste(x2[-length(x2)], collapse = "_")
  apis <- list_apis()
  x2 <- paste0("get_", apis[sapply(apis, grepl, x = x2, fixed = TRUE)])
  x <- sprintf("[`%s`](https://inrae.github.io/hubeau/reference/%s.html)", x, x2)
  regmatches(s, m) <- x
  s
}

s <- readLines("man-roxygen/hubeau.md")
s2 <- lapply(s, convert_link)
cat(paste(s2, collapse = "\n"))
```

A complete documentation is available on the package website: https://inrae.github.io/hubeau/

# Acknowledgements

The authors would like to thank the European Commission and the French National Research Agency (ANR) for funding in the frame of the collaborative  international consortium [IN-WOP](http://www.waterjpi.eu/joint-calls/joint-call-2018-waterworks-2017/booklet/in-wop) financed under the 2018 Joint call of the WaterWorks2017 ERA-NET Cofund. This ERA-NET is an integral part of the activities developed by the Water JPI.

![Water JPI](man/figures/logo_water_jpi.png) ![Water Works 2017](man/figures/logo_water_works_2017.png) ![European Commission](man/figures/logo_european_commission.jpg) ![2018 Joint call](man/figures/logo_2018_joint_call.png)

Owner

  • Name: INRAE
  • Login: inrae
  • Kind: organization
  • Location: France

INRAE, French National Institute for Agriculture, Food and Environment

GitHub Events

Total
  • Issues event: 9
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 4
  • Push event: 22
  • Pull request event: 1
  • Fork event: 1
  • Create event: 2
Last Year
  • Issues event: 9
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 4
  • Push event: 22
  • Pull request event: 1
  • Fork event: 1
  • Create event: 2

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 198
  • Total Committers: 6
  • Avg Commits per committer: 33.0
  • Development Distribution Score (DDS): 0.576
Past Year
  • Commits: 21
  • Committers: 1
  • Avg Commits per committer: 21.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
David Dorchies 1****h 84
Dorchies David d****s@i****r 57
Dorchies David d****s@i****r 42
PascalIrz p****z@g****m 13
cedric.mondy c****y@o****r 1
Sébastien Grall s****l@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 32
  • Total pull requests: 21
  • Average time to close issues: 3 months
  • Average time to close pull requests: 25 days
  • Total issue authors: 5
  • Total pull request authors: 5
  • Average comments per issue: 0.56
  • Average comments per pull request: 0.57
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 3
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 6 minutes
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 0.17
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • DDorch (26)
  • PascalIrz (3)
  • marqisoft (1)
  • Skady25 (1)
  • CedricMondy (1)
Pull Request Authors
  • DDorch (15)
  • PascalIrz (6)
  • LafageDenis (1)
  • SebastienGrall (1)
  • OFB-IdF (1)
Top Labels
Issue Labels
enhancement (11) bug (6) documentation (2) duplicate (1)
Pull Request Labels
documentation (2) enhancement (1)

Packages

  • Total packages: 2
  • Total downloads:
    • cran 665 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 13
  • Total maintainers: 1
proxy.golang.org: github.com/inrae/hubeau
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
cran.r-project.org: hubeau

Get Data from the French National Database on Water 'Hub'Eau'

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 665 Last month
Rankings
Forks count: 11.3%
Downloads: 19.2%
Average: 24.9%
Stargazers count: 28.5%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Maintainers (1)
Last synced: 10 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
DESCRIPTION cran
  • R >= 2.10 depends
  • dplyr * imports
  • httr * imports
  • purrr * imports
  • tibble * imports
  • urltools * imports
  • spelling * suggests
  • testthat >= 3.0.0 suggests