[Uwgarp-commits] r113 - pkg/GARPFRM/man

[noreply at r-forge.r-project.org]

Author: rossbennett34
Date: 2014-03-09 02:50:40 +0100 (Sun, 09 Mar 2014)
New Revision: 113

Added:
   pkg/GARPFRM/man/getSpec.Rd
Modified:
   pkg/GARPFRM/man/garch11.Rd
Log:
Minor revisions to GARCH code and docs

Modified: pkg/GARPFRM/man/garch11.Rd
===================================================================
--- pkg/GARPFRM/man/garch11.Rd	2014-03-09 01:49:05 UTC (rev 112)
+++ pkg/GARPFRM/man/garch11.Rd	2014-03-09 01:50:40 UTC (rev 113)
@@ -20,12 +20,12 @@
   “jsu” for Johnson's SU distribution.}
 }
 \description{
-  This function is a basic wrapper and functions in the
+  This function is a basic wrapper of functions in the
   rugarch and rmgarch packages to specify and fit GARCH
-  models. The rugarch and rmgarch packages provide a rich
-  set of GARCH models. The purpose of this function is to
-  specify and fit a GARCH model while abstracting away some
-  complexities.
+  models. The rugarch and rmgarch packages provide
+  functions to specify and fit a rich set of GARCH models.
+  The purpose of this function is to specify and fit a
+  GARCH model while abstracting away some complexities.
 }
 \details{
   The rugarch package implements univariate garch models
@@ -34,7 +34,7 @@
   detected and the appropriate GARCH model will be
   specified and fit.
 
-  For more complete functionality of GARCH models, it is
+  For complete functionality of GARCH models, it is
   recommended to directly use functions in the rugarch and
   rmgarch packages.
 }

Added: pkg/GARPFRM/man/getSpec.Rd
===================================================================
--- pkg/GARPFRM/man/getSpec.Rd	                        (rev 0)
+++ pkg/GARPFRM/man/getSpec.Rd	2014-03-09 01:50:40 UTC (rev 113)
@@ -0,0 +1,17 @@
+\name{getSpec}
+\alias{getSpec}
+\title{Get GARCH Specification}
+\usage{
+  getSpec(garch)
+}
+\arguments{
+  \item{garch}{a GARCH model specification and fit created
+  with \code{uvGARCH}}
+}
+\value{
+  an object of class uGARCHspec
+}
+\description{
+  Function to extract the GARCH specification object
+}
+