R/seismicRoll.R

In seismicRoll: Fast Rolling Functions for Seismology using 'Rcpp'

#' @docType package
#' @name seismicRoll-package
#' @aliases seismicRoll-package
#' @aliases seismicRoll
#' @title Fast Rolling Statistics for Seismology
#' @description This package implements fast versions of 'roll'-ing functions primarily for use in
#' seismology. It is intended for use with the \pkg{IRISSeismic} and \pkg{IRISMustangMetrics} packages
#' originally developed for the IRIS DMC, and now EarthScope Consortium (\url{https://www.earthscope.org}).
#' One advantage of the \pkg{seismicRoll} package is that all returned values are of
#' the same dimension as the incoming data with \code{NA}s where the rolling function
#' could not be calculated.
#' @details Currently exported functions include:
#' \itemize{
#'   \item{\code{\link{findOutliers}} -- outlier detection wrapper}
#'   \item{\code{\link{roll_hampel}} -- outlier detection}
#'   \item{\code{\link{roll_mean}} -- rolling mean}
#'   \item{\code{\link{roll_median}} -- rolling median (for outlier replacement)}
#'   \item{\code{\link{roll_sd}} -- rolling standard deviation}
#'   \item{\code{\link{roll_stalta}} -- first break picker}
#'   \item{\code{\link{roll_range}} -- rolling difference of max/min values}
#' }
#' 
#' \strong{History}
#'
#' version 1.1.5
#' \itemize{
#'  \item{fixed issue with package documentation, to meet CRAN requirements}
#'  \item{updated documentation for IRIS and UNAVCO merger to Earthscope, fixed urls}
#' }
#' 
#' version 1.1.4
#' \itemize{
#'   \item{bug fix for roll_range when NA values present}
#' }

#' version 1.1.3
#' \itemize{
#'   \item{minor changes to how the code compiles}
#'   \item{add roll_range function}
#' }
#'
#' version 1.1.2 -- bug fix
#' \itemize{
#'   \item{\code{findOutliers()} exits if the \code{roll_hampel()} return vector consists entirely of \code{NA} values.}
#' }
#' 
#' version 1.1.0 -- findOutliers update and bug fix
#' \itemize{
#'     \item{\code{findOutliers()} function default argument values changed. Now \code{thresholdMin=10},
#'           \code{selectivity=NA}, and \code{fixedThreshold=TRUE}.}
#'     \item{Bug fix in \code{roll_hampel()} handling \code{NA} values.}
#'}
#' 
#' version 1.0.3 -- findOutliers update
#' \itemize{
#'   \item{Added \code{fixedThreshold} argument to \code{findOutliers()} function.}
#' }
#' 
#' version 1.0.0 -- initial release
#' 
#' @useDynLib seismicRoll, .registration = TRUE
#' @importFrom Rcpp evalCpp
NULL