wql

Water Quality - Lite : Exploring Water Quality Monitoring Data

https://github.com/jsta/wql

Science Score: 36.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
  • Academic publication links
  • Committers with academic emails
    3 of 5 committers (60.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.5%) to scientific vocabulary

Keywords

cran rstats water-quality
Last synced: 10 months ago · JSON representation

Repository

Water Quality - Lite : Exploring Water Quality Monitoring Data

Basic Info
Statistics
  • Stars: 12
  • Watchers: 1
  • Forks: 4
  • Open Issues: 2
  • Releases: 3
Topics
cran rstats water-quality
Created about 9 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog

README.Rmd

---
output: github_document
---



```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# wql : Exploring Water Quality Monitoring Data

[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/wql)](https://cran.r-project.org/package=wql)

## Installation
### Stable version from CRAN

```{r, eval=FALSE}
install.packages("wql")
```

### or development version from GitHub
```{r, eval=FALSE}
install.packages("devtools")  # package devtools needed
devtools::install_github("jsta/wql")
```

## Motivation

The main purpose of wql is to explore seasonal time series through plots and nonparametric trend tests.  It was created originally to examine water quality data sets (hence, wql) but is suitable as a more general purpose set of tools for looking at annual or seasonal time series.

One of the more tedious tasks in exploring environmental data sets is creating usable time series from the original complex data sets, especially when you want many series at will that group data in different ways.  So wql also provides a way of transforming data sets to a common format that then allows a diversity of time series to be created quickly.  A few functions are specific to the fields of limnology and oceanography.

The plots are designed for easy use, not for publication-quality graphs.  Nonetheless, extensive customization is possible by passing options through ..., adding annotations in the case of base graphics, and adding layers in the case of ggplot2 objects.

Two functions are used mainly for preparing the times series:

* a function that transforms incoming data to a common data structure in the form of the WqData class
* a function that easily prepares time series objects from this class

The WqData class can be easily adapted to non-aquatic data.  Obviously, the depth field can be used for elevation in atmospheric studies.  But more generally, the site and depth fields can be used for many two-way classifications and don't need to refer to spatial location.

Some of the time series functions include:

* a variety of plots to examine changes in seasonal patterns
* nonparametric trend tests
* time series interpolation and related manipulations
* a simple decomposition of a series into different time scales
* phenological analyses
* the use of empirical orthogonal functions to detect multiple independent
mechanisms underlying temporal change

A few functions are specialized for the aquatic sciences:

* converting between oxygen concentrations and percent saturation
* converting between salinity and conductivity

## Usage

The capabilities of wql are more fully explained in the accompanying vignette: [wql: Exploring environmental monitoring data](https://jsta.github.io/wql/articles/wql-package.html)

## References

This package is an independent fork of the archived CRAN package `wq`. To date, improvements have been focused on improving the documentation and code readability.

```{r echo=FALSE}
citation("wql")
```

Owner

  • Name: Jemma Stachelek
  • Login: jsta
  • Kind: user
  • Location: New Mexico, USA
  • Company: Los Alamos National Laboratory

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 2
  • Watch event: 2
  • Push event: 9
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 2
  • Watch event: 2
  • Push event: 9

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 100
  • Total Committers: 5
  • Avg Commits per committer: 20.0
  • Development Distribution Score (DDS): 0.57
Past Year
  • Commits: 17
  • Committers: 1
  • Avg Commits per committer: 17.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
jsta s****2@m****u 43
jsta j****k@u****u 36
Alan Jassby a****y@u****u 14
Alan Jassby wq@f****t 6
Anthony Malkassian a****m@s****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 9
  • Total pull requests: 0
  • Average time to close issues: 11 days
  • Average time to close pull requests: N/A
  • Total issue authors: 3
  • Total pull request authors: 0
  • Average comments per issue: 0.22
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: 26 minutes
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jsta (7)
  • teunbrand (1)
  • troyhill (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 372 last-month
  • Total docker downloads: 21,647
  • Total dependent packages: 0
  • Total dependent repositories: 6
  • Total versions: 5
  • Total maintainers: 1
cran.r-project.org: wql

Exploring Water Quality Monitoring Data

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 6
  • Downloads: 372 Last month
  • Docker Downloads: 21,647
Rankings
Dependent repos count: 12.1%
Forks count: 12.3%
Stargazers count: 17.4%
Average: 19.0%
Downloads: 25.3%
Dependent packages count: 27.9%
Maintainers (1)
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.0.0 depends
  • ggplot2 >= 1.0 imports
  • grDevices * imports
  • graphics * imports
  • methods * imports
  • reshape2 * imports
  • stats * imports
  • zoo * imports
  • knitr * suggests
  • rmarkdown * suggests