Learn R Programming

wsyn: wavelet approaches to synchrony

Lawrence Sheppard, University of Kansas
Jonathan Walter, University of Virginia
Thomas Anderson, University of Kansas
Lei Zhao, China Agricultural University
Daniel C. Reuman, University of Kansas - maintainer

This repository provides tools for analyzing synchrony of time series from a timescale-specific viewpoint. The tools have so far principally been useful for studying spatial synchrony of population dynamics in ecology, but may be useful for a variety of other applications.

Explanations

In addition to the documentation, see the vignette, which is the best way to get started.

Installation

The package is on the Comprehensive R Archive Network (CRAN).

For a quick install of this development version: devtools::install_github(repo="reumandc/wsyn"). The install_github function, by default, will not install the vignette. There is an option for installing vignettes (build_vignettes=TRUE), but it seems finicky. You can also clone the repository and use devtools::install() to install from your local clone. The build_vignettes=TRUE option seems to work better for devtools::install than it does for devtools::install_github. If you have trouble, please email me.

Running all tests

Some of the more intensive tests are skipped unless there is a variable in the global environment called RUN_INTENSIVE_TESTS which is TRUE. This is so CRAN checks will run in the allowed time on CRAN servers, and was requested by CRAN.

Copy Link

Version

Install

install.packages('wsyn')

Monthly Downloads

195

Version

1.0.4

License

GPL-3

Maintainer

Daniel C. Reuman

Last Published

June 18th, 2021

Functions in wsyn (1.0.4)

clust_methods

Basic methods for the clust class
addwpmfs

Adds wavelet phasor mean field information to a clust object
cluseigen

Community structure detection in networks
addwmfs

Adds wavelet mean field information to a clust object
coh

Coherence
bandtest

Aggregate significance across a timescale band
cleandat

Clean (spatio)temporal data matrices to make them ready for analyses using the wsyn package
bctrans

The one-parameter family of Box-Cox transformations
addranks

Adds rank information to a coh or wlmtest object
clust

Detection and description of clusters of synchronous locations
is.connected

Tests if a graph is connected
errcheck_times

Error check times
mnphase

Mean phase of coherence
errcheck_wavparam

Error check wavelet transform parameters
plotphase

For plotting the phases of values in tts and coh objects
plotmap

Map clusters from a clust object
errcheck_tts

Error check whether inputs are suitable for a tts object
modularity

Modularity of a community structure of a graph
tts

Creator function for the tts class
synmat

Synchrony matrices
set_adj

Set and get methods for classes in the wsyn package
setmints

Shifts a vector according to the argument mints
wmf

Computes the wavelet mean field from a matrix of spatiotemporal data. Also the creator function for the wmf class.
surrog

Creates surrogate time series, either Fourier surrogates or amplitude adjusted Fourier surrogates
syncexpl

Amount of synchrony explained, and related quantities
wmf_methods

Basic methods for the wmf class
errcheck_tsdat

Error check for appropriate temporal data
fftsurrog

Surrogate time series using Fourier surrogates
fastcohtest

Fast algorithm for significance testing coherence using Fourier surrogates
plotrank

Plots ranks slot for coh and wlmtest objects
normforcoh

Normalization for the coh function
plotmag

For plotting the magnitude of values in tts, coh and wlmtest objects
makeunweighted

For converting certain synchrony matrices to unweighted versions
wt

Computes the wavelet transform of a timeseries. Also the creator function for the wt class.
power

Power of a tts object
wt_methods

Basic methods for the wt class
warray

Creates an array of wavelet transforms from input timeseries
wlmtest_methods

Basic methods for the wlmtest class
tts_methods

Basic methods for the tts class
wlmtest

Statistical comparison of wavelet linear models
wlm_methods

Basic methods for the wlm class
wlmfit

Fits a wavelet linear model
coh_methods

Basic methods for the coh class
errcheck_stdat

Error check for appropriate spatio-temporal data
predsync

Predicted synchrony of a wavelet linear model
wavmatwork

Facilitates the computations in synmat for coherence and ReXWT methods
wpmf

Wavelet phasor mean field
print.summary_wsyn

Print method for summary_wsyn class
wlm

Wavelet linear models
wpmf_methods

Basic methods for the wpmf class