Help files were re-created.

svkucheryavski · Jan 3, 2019 · a129cef · a129cef
1 parent 90b7ed6
commit a129cef
Show file tree

Hide file tree

Showing 49 changed files with 151 additions and 105 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -6,11 +6,12 @@ Author: Sergey Kucheryavskiy
 Maintainer: Sergey Kucheryavskiy <[email protected]>
 Description: Package implements projection based methods for preprocessing,
     exploring and analysis of multivariate data used in chemometrics.
+Encoding: UTF-8
 License: MIT + file LICENSE
 Imports:
     methods,
     graphics,
     grDevices,
     stats
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.1
 Suggests: testthat
diff --git a/NAMESPACE b/NAMESPACE
@@ -130,6 +130,8 @@ S3method(summary,simca)
 S3method(summary,simcam)
 S3method(summary,simcamres)
 S3method(summary,simcares)
+export(classres)
+export(crossval)
 export(erfinv)
 export(getCalibrationData)
 export(getConfusionMatrix)

diff --git a/R/pca.R b/R/pca.R
@@ -222,12 +222,14 @@ getCalibrationData.pca = function(obj, ...) {
 #' PCA model (object of class \code{pca})
 #' @param ncomp
 #' number of components to select
+#' @param ...
+#' other parameters if any
 #' 
 #' @return
 #' the same model with selected number of components
 #' 
 #' @export
-selectCompNum.pca = function(model, ncomp) {
+selectCompNum.pca = function(model, ncomp, ...) {
    if (ncomp < 1 || ncomp > model$ncomp)
       stop('Wrong number of selected components!')
 

diff --git a/R/pls.R b/R/pls.R
@@ -801,6 +801,8 @@ pls.crossval = function(model, x, y, cv, center, scale, method, jack.knife = T)
 #' @param selcrit
 #' criterion for selecting optimal number of components (\code{'min'} for 
 #' first local minimum of RMSECV and \code{'wold'} for Wold's rule.)
+#' @param ...
+#' other parameters if any
 #' 
 #' @return
 #' the same model with selected number of components
@@ -813,7 +815,7 @@ pls.crossval = function(model, x, y, cv, center, scale, method, jack.knife = T)
 #' See examples in help for \code{\link{pls}} function.
 #' 
 #' @export
-selectCompNum.pls = function(model, ncomp = NULL, selcrit = model$ncomp.selcrit) {
+selectCompNum.pls = function(model, ncomp = NULL, selcrit = model$ncomp.selcrit, ...) {
    if (!is.null(ncomp)) {
       # user defined number of components
       if (ncomp > model$ncomp || ncomp < 0)

diff --git a/man/getRegcoeffs.pls.Rd b/man/getRegcoeffs.pls.Rd
diff --git a/man/ipls.Rd b/man/ipls.Rd
diff --git a/man/ldecomp.getDistances.Rd b/man/ldecomp.getDistances.Rd
diff --git a/man/mdaplot.Rd b/man/mdaplot.Rd
diff --git a/man/mdaplot.getAxesLim.Rd b/man/mdaplot.getAxesLim.Rd
diff --git a/man/mdaplot.plotAxes.Rd b/man/mdaplot.plotAxes.Rd
diff --git a/man/mdaplot.showLines.Rd b/man/mdaplot.showLines.Rd
diff --git a/man/mdaplot.showRegressionLine.Rd b/man/mdaplot.showRegressionLine.Rd
diff --git a/man/mdaplotg.Rd b/man/mdaplotg.Rd
diff --git a/man/pca.Rd b/man/pca.Rd
diff --git a/man/pca.cal.Rd b/man/pca.cal.Rd
diff --git a/man/pca.mvreplace.Rd b/man/pca.mvreplace.Rd
diff --git a/man/plot.randtest.Rd b/man/plot.randtest.Rd
diff --git a/man/plot.regcoeffs.Rd b/man/plot.regcoeffs.Rd
diff --git a/man/plotCooman.simcamres.Rd b/man/plotCooman.simcamres.Rd
diff --git a/man/plotCumVariance.ldecomp.Rd b/man/plotCumVariance.ldecomp.Rd
diff --git a/man/plotModelDistance.simcam.Rd b/man/plotModelDistance.simcam.Rd
diff --git a/man/plotPerformance.classmodel.Rd b/man/plotPerformance.classmodel.Rd
diff --git a/man/plotPredictions.plsres.Rd b/man/plotPredictions.plsres.Rd
diff --git a/man/plotPredictions.regres.Rd b/man/plotPredictions.regres.Rd
diff --git a/man/plotRMSE.ipls.Rd b/man/plotRMSE.ipls.Rd
diff --git a/man/plotRMSE.regres.Rd b/man/plotRMSE.regres.Rd
diff --git a/man/plotResiduals.pcares.Rd b/man/plotResiduals.pcares.Rd
diff --git a/man/plotResiduals.simcares.Rd b/man/plotResiduals.simcares.Rd
diff --git a/man/plotScores.pca.Rd b/man/plotScores.pca.Rd