From 50a2a3b9e1316d6f68ae39eced629e352d5546cf Mon Sep 17 00:00:00 2001
From: Suraj Yerramilli
Date: Sat, 6 Jun 2015 22:45:42 +0530
Subject: Documenting spa

---
 man/spa.Rd | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

(limited to 'man')

diff --git a/man/spa.Rd b/man/spa.Rd
index 96fcb02..13778ea 100644
--- a/man/spa.Rd
+++ b/man/spa.Rd
@@ -12,10 +12,30 @@ spa(data, npad = 255)
 \item{npad}{an integer representing the total length of each time series
 to analyze after padding with zeros. This argument allows the user to
 control the spectral resolution of the SDF estimates: the normalized
-frequency interval is deltaf=1/npad. (Default:)}
+frequency interval is deltaf=1/npad. (Default: 255)}
+}
+\value{
+an \code{idfrd} object containing the estimated frequency response
 }
 \description{
 Estimates Frequency Response with fixed frequency resolution using
 spectral analysis
 }
+\details{
+The function calls the \code{SDF} function in the \code{sapa} package to
+compute the cross-spectral densities. The method used is \strong{Welch's
+Overlapped Segment Averaging} with a normalized \strong{Hanning} window.
+The overlap used is 50%.
+}
+\examples{
+data(frf)
+frf <- spa(data)
+}
+\references{
+Arun K. Tangirala (2015), \emph{Principles of System Identification:
+Theory and Practice}, CRC Press, Boca Raton. Sections 16.5 and 20.4
+}
+\seealso{
+\code{\link[sapa]{SDF}}
+}
 
-- 
cgit