Updated docs

gabraham · Mar 24, 2016 · 35a6bbe · 35a6bbe
1 parent a048ca4
commit 35a6bbe
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/flashpcaR/DESCRIPTION b/flashpcaR/DESCRIPTION
@@ -3,12 +3,12 @@ Depends: R(>= 3.0.2)
 Type: Package
 Title: R Interface to flashpca
 Version: 1.2.6
-Date: 2016-02-11
+Date: 2016-03-24
 Authors@R: c(
    person("Gad", "Abraham", , "[email protected]", c("aut", "cre"))
    )
 Description: flashpca is an efficient implementation of random principal
-   component analysisi (PCA), useful for rapidly estimating the top principal
+   component analysis (PCA), useful for rapidly estimating the top principal
    components of data. In addition to standard PCA, flashpca implements kernal PCA
    and sparse (L1-penalized) canonical correlation analysis (SCCA).
 URL:

diff --git a/flashpcaR/R/scca.R b/flashpcaR/R/scca.R
@@ -37,6 +37,9 @@
 #' X and Y contain values other than {0, 1, 2}, when stand="binom". This can
 #' be set to FALSE if you are sure your matrices only contain these values
 #' (only matters when using stand="binom").
+#' 
+#' @param V Numeric. A vector to initialise "v" in SCCA iterations. By
+#' default, it will be a vector of normally distributed variates.
 #'
 #' @return \code{scca} returns a list containing the following components:
 #'

diff --git a/flashpcaR/man/scca.Rd b/flashpcaR/man/scca.Rd