Learn R Programming

IRISMustangMetrics (version 2.4.7)

Statistics and Metrics for Seismic Data

Description

Classes and functions for metrics calculation as part of the 'EarthScope MUSTANG' project. The functionality in this package builds upon the base classes of the 'IRISSeismic' package. Metrics include basic statistics as well as higher level 'health' metrics that can help identify problematic seismometers.

Copy Link

Version

Install

install.packages('IRISMustangMetrics')

Monthly Downloads

424

Version

2.4.7

License

GPL (>= 2)

Maintainer

Last Published

December 11th, 2024

Functions in IRISMustangMetrics (2.4.7)

getBssMetricList

Retrieve measurements XML from the MUSTANG BSS and convert them to a metricList
getGeneralValueMetrics

Retrieve measurements from the MUSTANG BSS
correlationMetric

Correlation between channels
getMetricsXml

Retrieve measurements XML from the MUSTANG BSS
gapsMetric

Gaps and overlaps in a signal
convertBssErrors

Generate Human Readable MUSTANG Errors
crossCorrelationMetric

Correlation between channels
getMetricFunctionMetadata

Return JSON Metadata for Metric Functions
metricList2Xml

Create XML for the BSS
dailyDCOffsetMetric

DC Offset Detection
createBssUrl

Create URL to retrieve measurements from the MUSTANG BSS
metricList2DF

Convert a MetricList into a Tidy Dataframe
saveMetricList

Save a MetricList as RData or XML
sampleRateChannelMetric

Sample rate consistency between miniSEED and metadata
getMustangMetrics

Retrieve measurements from the MUSTANG BSS
getPsdMetrics

Retrieve measurements from the MUSTANG BSS
spectrumMetric2Xml

Convert a SpectrumMetric into XML for the BSS
sampleRateRespMetric

Sample rate consistency between miniSEED and metadata
maxRangeMetric

Maximum daily sample range calculated over a rolling window
getSingleValueMetrics

Retrieve measurements from the MUSTANG BSS
metricList2DFList

Conver a metricList into a list of dataframes
spikesMetric

Find spikes using a rolling Hampel filter
timesMetric2Xml

Create XML for the BSS
transferFunctionMetric

Cross-spectral comparison
stateOfHealthMetric

State of Health metrics
upDownTimesMetric

Up/down times for a channel
PSDMetric

Power Spectral Density of a signal
IRISMustangMetrics-package

Utilities for calculating seismic quality assurance metrics
SpectrumMetric-class

Class "SpectrumMetric"
MultipleTimeValueMetric-class

Class "MultipleTimeValueMetric"
SingleValueMetric-class

Class "SingleValueMetric"
DCOffsetTimesMetric

DC Offset Detection
basicStatsMetric

Min, median, mean, rms variance, max, and number of unique values of a signal
STALTAMetric

Maximum STA/LTA of a signal
SNRMetric

Signal to Noise Ratio
GeneralValueMetric-class

Class "GeneralValueMetric"