Data

Tools

Indexes

Applications

Experiments

Open Source Science

swtools

Tools to aid in hydrological data quality control

https://github.com/matt-s-gibbs/swtools

Science Score: 23.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
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 6 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Tools to aid in hydrological data quality control

Basic Info
  • Host: GitHub
  • Owner: matt-s-gibbs
  • Language: R
  • Default Branch: master
  • Size: 826 KB
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 3
Created over 8 years ago · Last pushed almost 2 years ago
Metadata Files
Readme

README.Rmd 

---
output: github_document
---




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

# SWTools: Helper Tools for Australian Hydrologists


  [![R-CMD-check](https://github.com/matt-s-gibbs/swtools/workflows/R-CMD-check/badge.svg)](https://github.com/matt-s-gibbs/swtools/actions)
  

Functions to speed up workflow for hydrological analysis. 
Focused on Australian climate data (SILO climate data), hydrological models (eWater Source) and South Australian hydrological data 
(from [Water Data SA](https://water.data.sa.gov.au)).

## SILO functions:

SILO is a database of Australian climate data from 1889 to the present. It provides daily meteorological datasets for a range of climate variables 
in ready-to-use formats suitable for biophysical modelling, research and climate applications [SILO Website](https://www.longpaddock.qld.gov.au/silo/).

These functions allow SILO data to be downloaded from the [SILO Website](https://www.longpaddock.qld.gov.au/silo/), imported into R, calculate some basic statistics and undertake some quality assurance tests to easily visualise how much data has been interpolated, and to compare nearby sites to identify potential data issues.
*SILODownload*, *SILOLoad* and *SILOReport* functions allow a vector of SILO sites to be downloaded and summarised in a Microsoft Word report.

## Source and Veneer functions:
[eWater Source](https://ewater.org.au/ewater-solutions/tools/source/) is the Australia's national hydrological modelling platform, and is increasing in use around the world.
Functions are included to write SILO climate data to the format expected for Source *SILOWriteforSource*,
 and reading in model outputs, *read_res.csv*.

[Veneer](https://www.flowmatters.com.au/articles/introducing_veneer.html) is a RESTful API for interacting with Source models.
Functions are included that are wrappers for Veneer, to build URLs to get or set data in the Source model, and process the json object returned.

## Aquarius functions:
South Australia's hydrological data is hosted on [Water Data SA](https://water.data.sa.gov.au), powered by an Aquatic Informatics Aquarius database. 
The [Export link](https://water.data.sa.gov.au/Data/Export) creates URLs that enable multiple datasets to be downloaded.
*AQWPDownload* builds these URLs to download data in json format, and *AWQPLoad* loads this json file into the R interface.

## Hydstra functions:
New South Wales, Queensland and Victoria use a Hydstra database, with the site information available over a 
[Kisters API](https://resources.kisters.com.au/public/hydstra-web-services/). *HydstraSiteDetails* uses this API to download streamflow site information, such as the cross section, rating curve, gaugings as well as the daily (9am-9am) time series of discharge data.

## Installation

You can install the released version of SWTools from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("SWTools")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("matt-s-gibbs/swtools")
```

Owner

  • Login: matt-s-gibbs
  • Kind: user

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 112
  • Total Committers: 6
  • Avg Commits per committer: 18.667
  • Development Distribution Score (DDS): 0.536
Past Year
  • Commits: 5
  • Committers: 2
  • Avg Commits per committer: 2.5
  • Development Distribution Score (DDS): 0.4
Top Committers
Name Email Commits
Matt Gibbs g****s@g****m 52
Matthew Gibbs a****4@a****u 27
Matt Gibbs m****s@c****u 22
Matt Gibbs M****s@e****u 7
Matt Gibbs m****s@s****u 3
m-alcorn 3****n 1
Committer Domains (Top 20 + Academic)
sa.gov.au: 1 env.sa.gov.au: 1 csiro.au: 1 adelaide.edu.au: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.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
Pull Request Authors
  • m-alcorn (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 284 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 11
  • Total maintainers: 1
cran.r-project.org: SWTools

Helper Tools for Australian Hydrologists

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 284 Last month
Rankings
Forks count: 21.9%
Stargazers count: 26.2%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Average: 35.6%
Downloads: 64.8%
Maintainers (1)
gibbs.ms@gmail.com
Last synced: 11 months ago

Dependencies

DESCRIPTION cran
  • R >= 4.0.0 depends
  • dplyr * imports
  • forcats * imports
  • ggmap * imports
  • ggplot2 * imports
  • httr * imports
  • hydroTSM * imports
  • jsonlite * imports
  • lubridate * imports
  • magrittr * imports
  • readr * imports
  • reshape2 * imports
  • rlang * imports
  • rmarkdown * imports
  • segmented * imports
  • sf * imports
  • sp * imports
  • stringr * imports
  • tibble * imports
  • tidyr * imports
  • zoo * imports
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 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