winfapreader

Interact with peak flow data in the UK

https://github.com/ilapros/winfapreader

Science Score: 49.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
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

Interact with peak flow data in the UK

Basic Info
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 4
Created about 7 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog

README.md

DOI CRAN Status Badge CRAN Total Downloads R-CMD-check

winfapReader allows a user to obtain data on long-term annual maxima and peaks over threshold for instantaneous river flow measurements in the UK. The user can also access the corollary catchment descriptors files which characterise the catchments upstream the gauging stations.

Two sets of functions are available: the read_* functions and the get_* functions. Both these sets of functions interact with annual maxima information (read_amax and get_amax), peaks over threshold information (read_pot and get_pot) and information on the catchment descriptors (read_cd3 and get_cd).

The read_* functions allow the user to read into their R console the data from the .AMAX, .PT and .CD3 files made available by the NRFA once these have been downloaded into the users' computer. At time of writing, Version 8 and previous versions of the winfap files can be downloaded from the NRFA website. This means that users who have compiled information for sites not included in the NRFA in the form of WINFAP files will be able to load these into R. The get_* functions allow the user to interact the the NRFA data API (terms and conditions).

The functions in the package rework the information of the WINFAP files and the NRFA API to provide user-friendly R data.frames derived from the original information.

One can install the latest version of winfapReader from github using the remotes package:

remotes::install_github("ilapros/winfapReader")

When reading files saved locally, by default the package assume that the winfap files are saved in the working directory, but this can be overwritten as in

max <- read_amax(72014, loc_WinFapFiles = "locationWhereWINFAPfilesAre")

When accessing the files via the API simply ask for one or more station to obtain the information requested

max <- get_amax(c(70005,72014))

Owner

  • Name: Ilaria Prosdocimi
  • Login: ilapros
  • Kind: user
  • Location: Veneto
  • Company: Ca' Foscari University of Venice

GitHub Events

Total
  • Issues event: 2
  • Issue comment event: 1
  • Push event: 3
  • Pull request event: 2
  • Create event: 1
Last Year
  • Issues event: 2
  • Issue comment event: 1
  • Push event: 3
  • Pull request event: 2
  • Create event: 1

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 34
  • Total Committers: 3
  • Avg Commits per committer: 11.333
  • Development Distribution Score (DDS): 0.206
Top Committers
Name Email Commits
ilapros p****a@g****m 27
Ilaria Prosdocimi i****s@u****m 6
Luke Shaw l****w@g****m 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 3 hours
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • 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
Top Authors
Issue Authors
  • ilapros (1)
Pull Request Authors
  • ilapros (3)
  • Luke-Shaw (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 264 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
cran.r-project.org: winfapReader

Interact with Peak Flow Data in the United Kingdom

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 264 Last month
Rankings
Forks count: 21.9%
Stargazers count: 28.5%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Average: 36.4%
Downloads: 66.2%
Maintainers (1)
Last synced: 8 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • utils * depends
  • lubridate * imports
  • curl * suggests
  • httr * suggests
  • jsonlite * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • rnrfa * suggests
  • testthat * suggests
  • utf8 * suggests
  • zoo * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite