Git Product home page Git Product logo

wql's Introduction

wql : Exploring Water Quality Monitoring Data

Project Status: Active – The project has reached a stable, usable state and is being actively developed. CRAN_Status_Badge

Installation

Stable version from CRAN

install.packages("wql")

or development version from GitHub

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

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.

#> 
#> To cite wq in publications use:
#> 
#>   Alan D. Jassby and James E. Cloern (). wq: Some tools for exploring
#>   water quality monitoring data. R package version 1.0.0.
#>   https://cran.r-project.org/package=wq
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{jassbywq,
#>     title = {wq: Exploring water quality monitoring data},
#>     author = {Alan D. Jassby and James E. Cloern},
#>     note = {R package version 1.0.0},
#>     url = {https://CRAN.R-project.org/package=wq},
#>   }

wql's People

Contributors

jsta avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

wql's Issues

eof/prcomp scale argument is hardcoded

I noticed that the scale. argument passed to wql::eof is not used in the function. I think that argument is intended to be used on line 89, but the scale argument in the prcomp call is hard-coded as TRUE (pr1 <- prcomp(x, scale.=TRUE)) instead of pr1 <- prcomp(x, scale.=scale.)

Thank you for the excellent package.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.