[Quantmod-commits] r627 - pkg/man

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

Author: efmrforge
Date: 2015-01-02 19:43:22 +0100 (Fri, 02 Jan 2015)
New Revision: 627

Added:
   pkg/man/addCCI.Rd
Log:
Added docs for addCCI


Added: pkg/man/addCCI.Rd
===================================================================
--- pkg/man/addCCI.Rd	                        (rev 0)
+++ pkg/man/addCCI.Rd	2015-01-02 18:43:22 UTC (rev 627)
@@ -0,0 +1,30 @@
+\name{addADX}
+\alias{addADX}
+\title{ Add Commodity Channel Index }
+\description{
+Add Commodity Channel Index
+}
+\usage{
+addCCI(n = 20, maType="SMA", c=0.015)
+}
+\arguments{
+  \item{n}{ periods to use for DX calculation}
+  \item{maType}{ moving average type }
+  \item{c}{ Constant to apply to the mean deviation.}
+}
+\details{
+See 'CCI' in \pkg{TTR} for specific details and references.
+}
+\value{
+An CCI indicator will be draw in a new window on the current
+chart.  A chobTA object will be returned silently.
+}
+\references{ see CCI in \pkg{TTR} written by Josh Ulrich }
+\author{Jeffrey A. Ryan }
+\seealso{ \code{\link{addTA}} }
+\examples{
+\dontrun{
+addCCI()
+}
+}
+\keyword{utilities}