README.md

In addisonklinke/rainflow: Extract cyclic features from compressed time series

rainflow

rainflow is an R package designed to extract cyclic features from compressed time series. It offers a variety of compression algorithms and follows standard ATSM E1049-85 for calculating the mean and amplitude for each cycle.

Installation

rainflow depends on R >= 3.3.3 From R, run the following commands:

# rainflow is not yet on CRAN, so you will need the devtools package to install from GitHub
install.packages("devtools")

# Then install rainflow itself
devtools::install_github("addisonklinke/rainflow")

Usage

See the sample weather dataset provided with the package for a general workflow

library("rainflow")
data(weather)
p <- FindPeaks(weather$temp, R = 1.1, smooth = TRUE, window = 120)
r <- CountCycles(p)
summary(r)
plot(r)

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

This project began during my master's thesis at Case Western Reserve University under professors Laura S. Bruckman and Roger H. French. Funding provided by the Solar Durability and Lifetime Extension Research Center (Ohio Third Frontier, Wright Project Program Award Tech 12-004) and the Department of Energy’s SunShot PREDICTS2 program (DE-EE0007143).

addisonklinke/rainflow documentation built on Aug. 23, 2020, 10:48 a.m.