diff --git a/R/develop.R b/R/develop.R new file mode 100644 index 0000000000000000000000000000000000000000..1f47a89b63e538bb3d757bb87e7b1181467ae201 --- /dev/null +++ b/R/develop.R @@ -0,0 +1,13 @@ +#' Develop a spectrum into a time series (generic) +#' @param arg: input class +#' @param times: if supplied, times of the decomposition +#' @param start: if supplied, overrides time and will generate a time series with start and deltat, which must then +#' be supplied as well +#' @param deltat : see start. +#' @note place holder for type-specific develop functions +#' @export develop +#' @return nothing +develop <- function(M, times=NULL, start=NULL, end=NULL, deltat=NULL,...){ + UseMethod("develop") +} + diff --git a/man/develop.Rd b/man/develop.Rd new file mode 100644 index 0000000000000000000000000000000000000000..34e5e43ef571b86e716183a3ad78e3f9945717aa --- /dev/null +++ b/man/develop.Rd @@ -0,0 +1,27 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/develop.R +\name{develop} +\alias{develop} +\title{Develop a spectrum into a time series (generic)} +\usage{ +develop(M, times = NULL, start = NULL, end = NULL, deltat = NULL, ...) +} +\arguments{ +\item{deltat}{: see start.} + +\item{arg:}{input class} + +\item{times:}{if supplied, times of the decomposition} + +\item{start:}{if supplied, overrides time and will generate a time series with start and deltat, which must then +be supplied as well} +} +\value{ +nothing +} +\description{ +Develop a spectrum into a time series (generic) +} +\note{ +place holder for type-specific develop functions +} diff --git a/man/develop.discreteSpectrum.Rd b/man/develop.discreteSpectrum.Rd new file mode 100644 index 0000000000000000000000000000000000000000..992f4486fd0b8a5a139aad8f1a6479c2eef591b5 --- /dev/null +++ b/man/develop.discreteSpectrum.Rd @@ -0,0 +1,31 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/mfft_support.R +\name{develop.discreteSpectrum} +\alias{develop.discreteSpectrum} +\title{MFFT reconstruction} +\usage{ +\method{develop}{discreteSpectrum}(M, times = NULL, start = NULL, end = NULL, deltat = NUL, sum = TRUE) +} +\arguments{ +\item{M}{: discreteSpectrum object} + +\item{deltat}{: see start.} + +\item{sum}{: TRUE if user wants to sum components %in% the reconstruction} + +\item{times:}{if supplied, times of the decomposition} + +\item{start:}{if supplied, overrides time and will generate a time series with start and deltat, which must then +be supplied as well} +} +\value{ +list of reconstructed components if sum=FALSE, full + reconstructed time series otherwise +} +\description{ +MFFT reconstruction +} +\note{ +if none if times, start and deltat are supplied, will reconstruct based on the attribute `xdata` + which must then be present. If no `xdata` is availble, return an error. +} diff --git a/man/discreteSpectrum.Rd b/man/discreteSpectrum.Rd new file mode 100644 index 0000000000000000000000000000000000000000..16c5f40a4b8d8360da6dc113e5506257225817d6 --- /dev/null +++ b/man/discreteSpectrum.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/mfft_support.R +\name{mfft_anova} +\alias{mfft_anova} +\alias{as.data.frame.discreteSpectrum} +\alias{plot.discreteSpectrum} +\alias{lines.discreteSpectrum} +\alias{print.discreteSpectrum} +\title{MFFT ANOVA +not ready. do not use.} +\usage{ +mfft_anova(M) + +\method{as.data.frame}{discreteSpectrum}(x) + +\method{plot}{discreteSpectrum}(M, periods = FALSE, labels = NULL, ...) + +\method{lines}{discreteSpectrum}(M, ...) + +\method{print}{discreteSpectrum}(M, ...) +} +\arguments{ +\item{periods}{if TRUE will add a lower axis with period labels} + +\item{labels}{to be set above the frequency peaks. Can be the output of `attributeTone`} + +\item{a}{`discreteSpectrum` object, typically the output of a `mfft` call.} +} +\description{ +MFFT ANOVA +not ready. do not use. +}