https://github.com/jrwishart/mwaved

mWaveD - R package
https://github.com/jrwishart/mwaved

Last synced: 30 days ago
JSON representation

mWaveD - R package

• Host: GitHub
• URL: https://github.com/jrwishart/mwaved
• Owner: jrwishart
• Created: 2014-07-11T03:46:00.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-01-16T23:31:03.000Z (almost 3 years ago)
• Last Synced: 2024-08-03T22:18:13.416Z (4 months ago)
• Language: C++
• Size: 299 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - jrwishart/mwaved - mWaveD - R package (C++)

README

        
mwaved

===========

[![Build Status](https://travis-ci.org/jrwishart/mwaved.svg?branch=master)](https://travis-ci.org/jrwishart/mwaved)[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/mwaved)](https://cran.r-project.org/package=mwaved) [![](https://cranlogs.r-pkg.org/badges/mwaved)](https://cran.r-project.org/package=mwaved) [![DL_Total](http://cranlogs.r-pkg.org/badges/grand-total/mwaved?color=blue)](https://cran.r-project.org/package=mwaved)

mwaved is a set of functions that generalise the waved package for wavelet deconvolution in the Fourier domain. These generalisations are the following extensions:

* Allow a multichannel model where the practitioner has access to multiple channels of data of a common signal of interest.

* Allow additive long memory errors to be present in the multichannel signals (independent between signals but exhibit long memory within each signal)

* Allow a data-driven resolution choice in the presence of box car blur (waved does not have this feature)

The user is encouraged to view the embedded Shiny applet that showcases the mwaved pacakge and importantly lists the appropriate R commands to recreate the output given by Shiny applet. The embedded Shiny applet can be viewed as long as the user has the [shiny](https://cran.r-project.org/package=shiny) package installed on their machine and then using R command `> mwaved::mWaveDDemo()`. 

The code is also written with the use of the Rcpp package to help use the external C FFTW library to achieve speeds around 8-15 times faster than the usual WaveD package (comparing the performance of a single channel waved code to the same code in the mwaved package with various sample sizes). The relative performance improves as the sample size increases. 

The package is being developed at https://github.com/jrwishart/mwaved and any bug reports, comments or suggestions are welcomed at https://github.com/jrwishart/mwaved/issues

Optional source compilation instructions (currently only tested in Ubuntu, Slackware Linux and Windows 10)

* Ensure you have the FFTW3 libraries installed. For ubuntu this requires `sudo apt-get install libfftw3-dev`. For Windows 10 this requires downloading the windows fftw3 binaries and adding the installed directories to your PATH.

* Download and install the package from your favourite CRAN repository. That is, run `install.packages('mwaved')` from the R prompt or download the tarball and run `R CMD INSTALL mwaved_1.x.x.tar.gz` (where x.x is replaced with the appropriate version name) from the linux terminal.