From e065ef9576c33b8d8710d44e3ab003e98eb140af Mon Sep 17 00:00:00 2001 From: Yonatan Tarazona Coronel Date: Sun, 28 Feb 2021 11:11:32 -0500 Subject: [PATCH] documentation. Adding missing arguments. --- man/calkmeans.Rd | 2 +- man/calmla.Rd | 3 +++ man/mla.Rd | 3 +++ man/plot.calkmeans.Rd | 15 +++++++++++++++ man/plot.pvts.Rd | 17 +++++++++++++++++ man/print.fusionRS.Rd | 3 +++ man/print.mla.Rd | 3 +++ man/print.pvts.Rd | 5 ++++- man/rkmeans.Rd | 5 +++-- man/smootH.Rd | 2 +- 10 files changed, 53 insertions(+), 5 deletions(-) diff --git a/man/calkmeans.Rd b/man/calkmeans.Rd index 7eeceb0..e9eb59a 100644 --- a/man/calkmeans.Rd +++ b/man/calkmeans.Rd @@ -33,7 +33,7 @@ expected to be obtained in the classification. Default is 30.} } \description{ This function allows to calibrate the kmeans algorithm. It is possible to obtain -the best k value and the best embedded algorithm in kmeans. +the best \code{k} value and the best embedded algorithm in kmeans. } \section{References}{ diff --git a/man/calmla.Rd b/man/calmla.Rd index 8c186eb..d70301e 100644 --- a/man/calmla.Rd +++ b/man/calmla.Rd @@ -43,6 +43,9 @@ Cross-Validation (K-fold) approach.} \item{iter}{Number of iterations, i.e number of times the analysis is executed.} \item{verbose}{This paramater is Logical. It Prints progress messages during execution.} + +\item{...}{Parameters to be passed in machine learning algorithm. Please see \link[e1071]{svm}, \link[randomForest]{randomForest}, +\link[e1071]{naiveBayes}, \link[caret]{train}, \link[nnet]{nnet} and \link[caret]{knn3}.} } \description{ This function allows to calibrate supervised classification in satellite images diff --git a/man/mla.Rd b/man/mla.Rd index ca1dae9..8531a15 100644 --- a/man/mla.Rd +++ b/man/mla.Rd @@ -23,6 +23,9 @@ like \code{model = 'nnet'}, K-nearest Neighbors (\link[caret]{knn3}) like \code{ testing data.} \item{verbose}{This paramater is Logical. It Prints progress messages during execution.} + +\item{...}{Parameters to be passed in machine learning algorithm. Please see \link[e1071]{svm}, \link[randomForest]{randomForest}, +\link[e1071]{naiveBayes}, \link[caret]{train}, \link[nnet]{nnet} and \link[caret]{knn3}.} } \description{ This developed function allows to execute supervised classification diff --git a/man/plot.calkmeans.Rd b/man/plot.calkmeans.Rd index 24dc95e..b46d737 100644 --- a/man/plot.calkmeans.Rd +++ b/man/plot.calkmeans.Rd @@ -6,6 +6,21 @@ \usage{ \method{plot}{calkmeans}(x, xlab, ylab, type, main, cex, ...) } +\arguments{ +\item{x}{Object of class "calkmeans".} + +\item{xlab}{X-axis title.} + +\item{ylab}{Y-axis title.} + +\item{type}{Type of line.} + +\item{main}{Title of the graph.} + +\item{cex}{Graph line point size.} + +\item{...}{Graphical parameters to be passed in \link[base]{plot}.} +} \description{ Plot for the "calkmeans" class } diff --git a/man/plot.pvts.Rd b/man/plot.pvts.Rd index f4572a8..9d8a836 100644 --- a/man/plot.pvts.Rd +++ b/man/plot.pvts.Rd @@ -6,6 +6,23 @@ \usage{ \method{plot}{pvts}(x, ylab, type, col, lwd, main, ...) } +\arguments{ +\item{x}{Object of class "pvts".} + +\item{ylab}{Y-axis title.} + +\item{type}{Type of line.} + +\item{col}{Type of color line.} + +\item{lwd}{Line thickness size.} + +\item{main}{Title of the graph.} + +\item{...}{Graphical parameters to be passed in \link[base]{plot}.} + +\item{cex}{Graph line point size.} +} \description{ Plot for the "pvts" class } diff --git a/man/print.fusionRS.Rd b/man/print.fusionRS.Rd index 0206703..ae98eca 100644 --- a/man/print.fusionRS.Rd +++ b/man/print.fusionRS.Rd @@ -6,6 +6,9 @@ \usage{ \method{print}{fusionRS}(x) } +\arguments{ +\item{x}{Object of class "fusionRS".} +} \description{ Print for the "fusionRS" class } diff --git a/man/print.mla.Rd b/man/print.mla.Rd index 2f90de7..0a498be 100644 --- a/man/print.mla.Rd +++ b/man/print.mla.Rd @@ -6,6 +6,9 @@ \usage{ \method{print}{mla}(x) } +\arguments{ +\item{x}{Object of class "mla".} +} \description{ Print for the "mla" class } diff --git a/man/print.pvts.Rd b/man/print.pvts.Rd index 4c25c08..d8350b7 100644 --- a/man/print.pvts.Rd +++ b/man/print.pvts.Rd @@ -4,7 +4,10 @@ \alias{print.pvts} \title{Printing for the "pvts" class} \usage{ -\method{print}{pvts}(x, ...) +\method{print}{pvts}(x) +} +\arguments{ +\item{x}{Object of class "pvts".} } \description{ Printing for the "pvts" class diff --git a/man/rkmeans.Rd b/man/rkmeans.Rd index ab99e6d..4cf8565 100644 --- a/man/rkmeans.Rd +++ b/man/rkmeans.Rd @@ -10,6 +10,7 @@ rkmeans( iter.max = 100, nstart = 50, algo = c("Hartigan-Wong", "Lloyd", "Forgy", "MacQueen"), + verbose = FALSE, ... ) } @@ -24,9 +25,9 @@ rkmeans( \item{algo}{It can be "Hartigan-Wong", "Lloyd", "Forgy" or "MacQueen". See \link[stats]{kmeans}.} -\item{...}{Options to be passed to the function. See \link[stats]{kmeans}.} - \item{verbose}{This paramater is Logical. It Prints progress messages during execution.} + +\item{...}{Options to be passed to the function. See \link[stats]{kmeans}.} } \description{ This function allows to classify satellite images using k-means. diff --git a/man/smootH.Rd b/man/smootH.Rd index 21c61ff..13d51e5 100644 --- a/man/smootH.Rd +++ b/man/smootH.Rd @@ -9,7 +9,7 @@ smootH(x, method.interp = "na.interp") \arguments{ \item{x}{Numeric, matrix.} -\item{interp}{Four interpolation methods are presented, "na.interp", +\item{method.interp}{Four interpolation methods are presented, "na.interp", "na.approx" and "na.spline". By default is the method "na.interp".} } \description{