In mps9506/tbrf: Time-Based Rolling Functions

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "##",
  fig.path = "man/figures/README-",
  fig.retina = 2
)

tbrf

tbrf is retired. I will maintain the package to ensure it remains on CRAN but do not expect additional functionality or improvements. I highly recommend runner for the same functionality but faster!

The goal of tbrf is to provide time-window based rolling statistical functions. The package differs from other rolling statistic packages because the intended use is for irregular measured data. Although tbrf can be used to apply statistical functions to regularly sampled data, zoo, RcppRoll, and other packages provide fast, efficient, and rich implementations of rolling/windowed functions.

An appropriate example case is water quality data that is measured at irregular time intervals. Regulatory compliance is often based on a statistical average measure or exceedance probability applied to all samples collected in the previous 7-years. tbrf can be used to display regulatory status at any sample point.

tbrf identifies the previous n measurements within the specified time window, applies the function, and outputs a variable with the result of the rolling statistical measure.

Installation

tbrf is available on CRAN:

install.packages("tbrf")

The development version is maintained on github and can be installed as:

install.packages(remotes)
remotes::install_github("mps9506/tbrf")

Available Functions

• tbr_binom: Rolling binomial probability with confidence intervals.

• tbr_gmean: Rolling geometric mean with confidence intervals.

• tbr_mean: Rolling mean with confidence intervals.

• tbr_median: Rolling median with confidence intervals.

• tbr_misc: Accepts user specified function.

• tbr_sd: Rolling standard deviation.

• tbr_sum: Rolling sum.

Usage

See:

https://mps9506.github.io/tbrf/

Example

Plot a rolling 1-hour mean:

library(tbrf)
library(dplyr)
library(ggplot2)
library(ggalt)

y = 3 * sin(2 * seq(from = 0, to = 4*pi, length.out = 100)) + rnorm(100)
time = sample(seq(as.POSIXct(strptime("2017-01-01 00:01:00", "%Y-%m-%d %H:%M:%S")),
                  as.POSIXct(strptime("2017-01-01 23:00:00", "%Y-%m-%d %H:%M:%S")),
                  by = "min"), 100)

df <- tibble(y, time)

df %>%
  tbr_mean(y, time, "hours", n = 1) %>%
  ggplot() +
  geom_point(aes(time, y)) +
  geom_step(aes(time, mean))

Plot a rolling 3-hour mean:

df %>%
  tbr_mean(y, time, "hours", n = 3) %>%
  ggplot() +
  geom_point(aes(time, y)) +
  geom_step(aes(time, mean))

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

tbrf code is released under GPL-3 | LICENSE.md

binom_ci() is an implementation of code licensed under GPL (>=2) by Frank Harrell's Hmisc package.

If you can cite the use of this software, please use citation("tbrf")

Test Results

library(tbrf)

date()

devtools::test()

mps9506/tbrf documentation built on May 20, 2022, 10:49 a.m.