Documentation fixes

DESCRIPTION

@@ -3,8 +3,9 @@ Type:        Package
 Title:       Efficiently calculate Cliff's delta effect size metric 
 Version:     1.0
 Date:        2013-08-23
+URL:         https://github.com/gousiosg/cliffs.d
 Author:      Georgios Gousios
 Maintainer:  Georgios Gousios <G.Gousios@tudelft.nl>
 Description: Calculate Cliff's delta using a tight C loop instead of examining
-             the dominance table. Can process reasonably large inputs.
+             the dominance table. Can handle reasonably large inputs.
 License:     MIT

man/cliffs.d.Rd

@@ -1,53 +1,34 @@
 \name{cliffs.d}
 \alias{cliffs.d}
-%- Also NEED an '\alias' for EACH other topic documented here.
 \title{
 Calculate Cliff's delta effect size for ordinal variables
 }
 \description{
 Calculate Cliff's delta efficiently using a C loop instead of calculating the
-dominance array in memory. Can handle very large vectors at its input.
+dominance array in memory. Can handle reasonably large vectors at its input.
 }
 \usage{
 cliffs.d(a, b)
 }
-%- maybe also 'usage' for other objects documented here.
 \arguments{
   \item{a}{
-%%     ~~Describe \code{control} here~~
+  numeric vector for the treatment group
 }
   \item{b}{
-%%     ~~Describe \code{pilot} here~~
+  numeric vector for the control group
 }
 }
-\details{
-%%  ~~ If necessary, more details than the description above ~~
-}
 \value{
-%%  ~Describe the value returned
-%%  If it is a LIST, use
-%%  \item{comp1 }{Description of 'comp1'}
-%%  \item{comp2 }{Description of 'comp2'}
-%% ...
+  the Cliff's delta metric
 }
 \references{
-%% ~put references to the literature/web site here ~
 Norman Cliff (1996). Ordinal methods for behavioral data analysis. Routledge.
 
 K.Y. Hogarty and J.D.Kromrey (1999). Using SAS to Calculate Tests of Cliff's Delta. Proceedings of the Twenty-Foursth Annual SAS User Group International Conference, Miami Beach, Florida, p 238.
 Available at: \url{http://www2.sas.com/proceedings/sugi24/Posters/p238-24.pdf}
 }
 \author{
-%%  ~~who you are~~
-}
-\note{
-%%  ~~further notes~~
-}
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
-\seealso{
-%% ~~objects to See Also as \code{\link{help}}, ~~~
+Georgios Gousios <G.Gousios@tudelft.nl> TU Delft, NL
 }
 \examples{
 ## Example data from Hogarty and Kromrey (1999)
@@ -57,4 +38,4 @@ res <- cliffs.d(control, treatment)
 print(res)
 }
 \keyword{ effect size }
-\keyword{Cliff}% __ONLY ONE__ keyword per line
+\keyword{Cliff's delta}