Package: IRISMustangMetrics 2.4.6

IRISMustangMetrics: Statistics and Metrics for Seismic Data

Classes and functions for metrics calculation as part of the 'IRIS DMC 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.

Authors:Jonathan Callahan [aut], Rob Casey [aut], Mary Templeton [aut], Gillian Sharer [aut, cre]

IRISMustangMetrics_2.4.6.tar.gz
IRISMustangMetrics_2.4.6.zip(r-4.5)IRISMustangMetrics_2.4.6.zip(r-4.4)IRISMustangMetrics_2.4.6.zip(r-4.3)
IRISMustangMetrics_2.4.6.tgz(r-4.4-any)IRISMustangMetrics_2.4.6.tgz(r-4.3-any)
IRISMustangMetrics_2.4.6.tar.gz(r-4.5-noble)IRISMustangMetrics_2.4.6.tar.gz(r-4.4-noble)
IRISMustangMetrics_2.4.6.tgz(r-4.4-emscripten)IRISMustangMetrics_2.4.6.tgz(r-4.3-emscripten)
IRISMustangMetrics.pdf |IRISMustangMetrics.html
IRISMustangMetrics/json (API)

# Install 'IRISMustangMetrics' in R:
install.packages('IRISMustangMetrics', repos = c('https://gillian-earthscope.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

On CRAN:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

31 exports 1 stars 0.23 score 27 dependencies 27 scripts 528 downloads

Last updated 1 years agofrom:e000a1cd3e. Checks:OK: 3 NOTE: 4. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 16 2024
R-4.5-winNOTESep 16 2024
R-4.5-linuxNOTESep 16 2024
R-4.4-winNOTESep 16 2024
R-4.4-macNOTESep 16 2024
R-4.3-winOKSep 16 2024
R-4.3-macOKSep 16 2024

Exports:basicStatsMetricconvertBssErrorscorrelationMetriccreateBssUrlcrossCorrelationMetricdailyDCOffsetMetricDCOffsetTimesMetricgapsMetricgetBssMetricListgetGeneralValueMetricsgetMetricFunctionMetadatagetMetricsXmlgetMustangMetricsgetPsdMetricsgetSingleValueMetricsmaxRangeMetricmetricList2DFmetricList2DFListmetricList2XmlPSDMetricsampleRateChannelMetricsampleRateRespMetricsaveMetricListSNRMetricspectrumMetric2XmlspikesMetricSTALTAMetricstateOfHealthMetrictimesMetric2XmltransferFunctionMetricupDownTimesMetric

Dependencies:bitopsclidplyrfansigenericsglueIRISSeismiclifecyclemagrittrMASSpillarpkgconfigpracmaR6RcppRCurlrlangseismicRollsignalstringistringrtibbletidyselectutf8vctrswithrXML

Readme and manuals

Help Manual

Help pageTopics
Utilities for calculating seismic metrics from EarthScope (formerly IRIS DMC) dataIRISMustangMetrics-package IRISMustangMetrics
Min, median, mean, rms variance, max, and number of unique values of a signalbasicStatsMetric
Generate Human Readable MUSTANG ErrorsconvertBssErrors
Correlation between channelscorrelationMetric
Create URL to retrieve measurements from the MUSTANG BSScreateBssUrl createBssUrl,IrisClient,character,character,character,character,POSIXct,POSIXct,character-method
Correlation between channelscrossCorrelationMetric
DC Offset DetectiondailyDCOffsetMetric
DC Offset DetectionDCOffsetTimesMetric
Gaps and overlaps in a signalgapsMetric
Class '"GeneralValueMetric"'GeneralValueMetric-class show,GeneralValueMetric-method
Retrieve measurements XML from the MUSTANG BSS and convert them to a metricListgetBssMetricList getBssMetricList,IrisClient,character,character,character,character,POSIXct,POSIXct,character,character-method getBssMetricList,IrisClient,character,character,character,character,POSIXct,POSIXct,character,missing-method
Retrieve measurements from the MUSTANG BSSgetGeneralValueMetrics getGeneralValueMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,character-method
Return JSON Metadata for Metric FunctionsgetMetricFunctionMetadata
Retrieve measurements XML from the MUSTANG BSSgetMetricsXml getMetricsXml,IrisClient,character,character,character,character,POSIXct,POSIXct,character,character-method getMetricsXml,IrisClient,character,character,character,character,POSIXct,POSIXct,character,missing-method
Retrieve measurements from the MUSTANG BSSgetMustangMetrics getMustangMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,character-method
Retrieve measurements from the MUSTANG BSSgetPsdMetrics getPsdMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,character-method getPsdMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,missing-method
Retrieve measurements from the MUSTANG BSSgetSingleValueMetrics getSingleValueMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,character,character,character-method getSingleValueMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,character,character,missing-method getSingleValueMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,character,missing,character-method getSingleValueMetrics,IrisClient,character,character,character,character,POSIXct,POSIXct,character,missing,missing-method
Maximum daily sample range calculated over a rolling windowmaxRangeMetric
Convert a MetricList into a Tidy DataframemetricList2DF
Conver a metricList into a list of dataframesmetricList2DFList
Create XML for the BSSmetricList2Xml
Class '"MultipleTimeValueMetric"'MultipleTimeValueMetric-class show,MultipleTimeValueMetric-method
Power Spectral Density of a signalPSDMetric
Sample rate consistency between miniSEED and metadatasampleRateChannelMetric
Sample rate consistency between miniSEED and metadatasampleRateRespMetric
Save a MetricList as RData or XMLsaveMetricList
Class '"SingleValueMetric"'show,SingleValueMetric-method SingleValueMetric SingleValueMetric-class
Signal to Noise RatioSNRMetric
Class '"SpectrumMetric"'show,SpectrumMetric-method SpectrumMetric SpectrumMetric-class
Convert a SpectrumMetric into XML for the BSSspectrumMetric2Xml
Find spikes using a rolling Hampel filterspikesMetric
Maximum STA/LTA of a signalSTALTAMetric
State of Health metricsstateOfHealthMetric
Create XML for the BSStimesMetric2Xml
Cross-spectral comparisontransferFunctionMetric
Up/down times for a channelupDownTimesMetric