[Candlesticks-commits] r4 - in pkg: . man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sun Jan 15 13:25:12 CET 2012
Author: wotuzu17
Date: 2012-01-15 13:25:12 +0100 (Sun, 15 Jan 2012)
New Revision: 4
Added:
pkg/man/CSPNLongWhiteCandles.Rd
pkg/man/CSPStar.Rd
pkg/man/CSPThreeBlackCrows.Rd
pkg/man/CSPThreeWhiteSoldiers.Rd
Modified:
pkg/DESCRIPTION
Log:
added documentation
Modified: pkg/DESCRIPTION
===================================================================
--- pkg/DESCRIPTION 2012-01-12 19:41:06 UTC (rev 3)
+++ pkg/DESCRIPTION 2012-01-15 12:25:12 UTC (rev 4)
@@ -1,8 +1,8 @@
Package: candlesticks
Type: Package
Title: Candlestick Pattern Recognition
-Version: 0.1-2
-Date: 2012-01-12
+Version: 0.1-3
+Date: 2012-01-15
Author: Andreas Voellenklee
Maintainer: Andreas Voellenklee <wotuzu17 at gmail.com>
Depends: R (>= 2.13), xts (>= 0.8-2), quantmod (>= 0.3-17), TTR (>= 0.21-0)
Added: pkg/man/CSPNLongWhiteCandles.Rd
===================================================================
--- pkg/man/CSPNLongWhiteCandles.Rd (rev 0)
+++ pkg/man/CSPNLongWhiteCandles.Rd 2012-01-15 12:25:12 UTC (rev 4)
@@ -0,0 +1,46 @@
+\name{CSPNLongWhiteCandles}
+\alias{CSPNLongWhiteCandles}
+\alias{CSPNLongBlackCandles}
+\alias{CSPNLongWhiteCandleBodies}
+\alias{CSPNLongBlackCandleBodies}
+\title{N consecutive long candles / bodies of same color}
+\description{look for N consecutive long candles / long candle bodies of same color}
+\usage{
+CSPNLongWhiteCandles(TS, N=2, n=20, threshold=1.5)
+CSPNLongBlackCandles(TS, N=2, n=20, threshold=1.5)
+CSPNLongWhiteCandleBodies(TSOC, N=2, n=20, threshold=1.5)
+CSPNLongBlackCandleBodies(TSOC, N=2, n=20, threshold=1.5)
+}
+\arguments{
+ \item{TS}{xts Time Series containing OHLC prices}
+ \item{TSOC}{xts Time Series containing Open and Close prices}
+ \item{N}{number of candles to test}
+ \item{n}{number of preceding candles to calculate median candle length}
+ \item{threshold}{minimum/maximum candle length in relation to the median candle length of \code{n} preceding candles}
+}
+\details{}
+\value{
+ A xts object containing the column:
+ \item{<N>LongWhiteCandles}{TRUE if current candle is the \code{N}-th consecutive long white candle}
+ \item{<N>LongBlackCandles}{TRUE if current candle is the \code{N}-th consecutive long black candle}
+ \item{<N>LongWhiteCandleBodies}{TRUE if current candle is the \code{N}-th consecutive long white candle body}
+ \item{<N>LongBlackCandleBodies}{TRUE if current candle is the \code{N}-th consecutive long black candle body}
+}
+\author{Andreas Voellenklee}
+\references{
+}
+\note{}
+\seealso{
+\code{\link{CSPLongCandle}}
+\code{\link{CSPLongCandleBody}}
+}
+\examples{
+\dontrun{
+ getSymbols('YHOO',adjust=TRUE)
+ CSPNLongWhiteCandle(YHOO)
+ CSPNLongBlackCandle(YHOO, N=3)
+ CSPNLongWhiteCandleBodies(YHOO)
+ CSPNLongBlackCandleBodies(YHOO, N=4, n=50, threshold=1.2)
+}
+}
+\keyword{}
Added: pkg/man/CSPStar.Rd
===================================================================
--- pkg/man/CSPStar.Rd (rev 0)
+++ pkg/man/CSPStar.Rd 2012-01-15 12:25:12 UTC (rev 4)
@@ -0,0 +1,43 @@
+\name{CSPStar}
+\alias{CSPStar}
+\alias{MorningStar}
+\alias{EveningStar}
+\title{Morning/Evening Star Candlestick Pattern}
+\description{Look for Morning/Evening Star Patterns in a OHLC price series}
+\usage{
+CSPStar(TS, n=20, lthreshold=1.5, sthreshold=1)
+}
+\arguments{
+ \item{TS}{xts Time Series containing OHLC prices}
+ \item{n}{number of preceding candles to calculate median candle length}
+ \item{lthreshold}{minimum candle length in relation to the median candle length of the formation's \emph{first} candle}
+ \item{sthreshold}{maximum candle length in relation to the median candle length of the formation's \emph{second} candle}
+}
+\details{
+ Number of candle lines: \bold{3}\cr\cr
+ \emph{Morning Star:}\cr
+ The market is in downtrend. The first candlestick is a long black body; the second one is a small real body of either color. It is characteristically marked with a gap in lower direction thus forming a star. Finally we see the black candlestick with a closing price well within first session’s black real body. This pattern clearly shows that the market now turned bullish.\cr\cr
+ \emph{Evening Star:}\cr
+ The market is in uptrend. The first candlestick is a long white body; the second one is a small real body of either color. It is characteristically marked with a gap in higher direction thus forming a star. Finally we see the black candlestick with a closing price well within first session’s white real body. This pattern clearly shows that the market now turned bearish.
+}
+\value{
+ A xts object containing the columns:
+ \item{MorningStar}{TRUE if Morning Star pattern detected}
+ \item{EveningStar}{TRUE if Evening Star pattern detected}
+}
+\author{Andreas Voellenklee}
+\references{
+The following site(s) were used to code/document this indicator:\cr
+ \url{http://www.candlesticker.com/Bullish.asp}\cr
+ \url{http://www.candlesticker.com/Bearish.asp}
+}
+\note{Trend detection prior to the formation is not implemented yet}
+\seealso{}
+\examples{
+\dontrun{
+ getSymbols('YHOO',adjust=TRUE)
+ CSPStar(YHOO)
+ CSPStar(YHOO, sthreshold=.5) # allow only a small second candle body
+}
+}
+\keyword{}
Added: pkg/man/CSPThreeBlackCrows.Rd
===================================================================
--- pkg/man/CSPThreeBlackCrows.Rd (rev 0)
+++ pkg/man/CSPThreeBlackCrows.Rd 2012-01-15 12:25:12 UTC (rev 4)
@@ -0,0 +1,42 @@
+\name{CSPThreeBlackCrows}
+\alias{CSPThreeBlackCrows}
+\alias{ThreeBlackCrows}
+\title{Three Black Crows Candlestick Pattern}
+\description{Look for Three Black Crows in a Open/Close price series}
+\usage{
+ CSPThreeBlackCrows(TS, strict=TRUE, n=20, threshold=1.5)
+}
+\arguments{
+ \item{TS}{xts Time Series containing Open and Close prices}
+ \item{strict}{if FALSE, use less strict conditions to detect pattern. See details.}
+ \item{n}{number of preceding candles to calculate median candle length}
+ \item{threshold}{minimum candle length in relation to the median candle length of \code{n} preceding candles}
+}
+\details{
+ Number of candle lines: \bold{3}\cr\cr
+ The market forms a uptrend. The pattern is characterized by three long candlesticks stepping downward like a staircase. In strict mode, the opening of each day is higher than the previous close but lower than the previous open. When strict=FALSE, candle 2 and/or 3 of the formation may open lower than the previous day's close, thus forming a gap.
+}
+\value{
+ A xts object containing the column:
+ \item{ThreeBlackCrows}{TRUE if Three Black Crows pattern detected}
+}
+\author{Andreas Voellenklee}
+\references{
+The following site(s) were used to code/document this indicator:\cr
+ \url{http://www.candlesticker.com/Bullish.asp}\cr
+ \url{http://www.candlesticker.com/Bearish.asp}
+}
+\note{Trend detection prior to the formation is not implemented yet}
+\seealso{
+ \code{\link{ThreeWhiteSoldiers}}
+ \code{\link{CSPNLongBlackCandles}}
+ \code{\link{CSPNLongBlackCandleBodies}}
+}
+\examples{
+\dontrun{
+ getSymbols('YHOO',adjust=TRUE)
+ CSPThreeBlackCrows(YHOO)
+ CSPThreeBlackCrows(YHOO, strict=FALSE)
+}
+}
+\keyword{}
Added: pkg/man/CSPThreeWhiteSoldiers.Rd
===================================================================
--- pkg/man/CSPThreeWhiteSoldiers.Rd (rev 0)
+++ pkg/man/CSPThreeWhiteSoldiers.Rd 2012-01-15 12:25:12 UTC (rev 4)
@@ -0,0 +1,42 @@
+\name{CSPThreeWhiteSoldiers}
+\alias{CSPThreeWhiteSoldiers}
+\alias{ThreeWhiteSoldiers}
+\title{Three White Soldiers Candlestick Pattern}
+\description{Look for Three White Soldiers in a Open/Close price series}
+\usage{
+ CSPThreeWhiteSoldiers(TS, strict=TRUE, n=20, threshold=1.5)
+}
+\arguments{
+ \item{TS}{xts Time Series containing Open and Close prices}
+ \item{strict}{if FALSE, use less strict conditions to detect pattern. See details.}
+ \item{n}{number of preceding candles to calculate median candle length}
+ \item{threshold}{minimum candle length in relation to the median candle length of \code{n} preceding candles}
+}
+\details{
+ Number of candle lines: \bold{3}\cr\cr
+ The market forms a downtrend. The pattern is characterized by three long candlesticks stepping upward like a staircase. In strict mode, the opening of each day is lower than the previous close but higher than the previous open. When strict=FALSE, candle 2 and/or 3 of the formation may open higher than the previous day's close, thus forming a gap.
+}
+\value{
+ A xts object containing the column:
+ \item{ThreeWhiteSoldiers}{TRUE if Three White Soldiers pattern detected}
+}
+\author{Andreas Voellenklee}
+\references{
+The following site(s) were used to code/document this indicator:\cr
+ \url{http://www.candlesticker.com/Bullish.asp}\cr
+ \url{http://www.candlesticker.com/Bearish.asp}
+}
+\note{Trend detection prior to the formation is not implemented yet}
+\seealso{
+ \code{\link{ThreeBlackCrows}}
+ \code{\link{CSPNLongWhiteCandles}}
+ \code{\link{CSPNLongWhiteCandleBodies}}
+}
+\examples{
+\dontrun{
+ getSymbols('YHOO',adjust=TRUE)
+ CSPThreeWhiteSoldiers(YHOO)
+ CSPThreeWhiteSoldiers(YHOO, strict=FALSE)
+}
+}
+\keyword{}
More information about the Candlesticks-commits
mailing list