From d564f1aaecf0828d17a4314431741d1608ceeac4 Mon Sep 17 00:00:00 2001
From: paulo <paulo.santos@meantrix.com>
Date: Thu, 9 Jan 2025 15:09:46 -0300
Subject: [PATCH] General comments for review #27 udpate documentation in
 corr_rm

---
 R/corr_rm.R    | 13 ++++++++-----
 man/corr_rm.Rd | 13 ++++++++-----
 2 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/R/corr_rm.R b/R/corr_rm.R
index 48c2255..d211b56 100644
--- a/R/corr_rm.R
+++ b/R/corr_rm.R
@@ -5,19 +5,22 @@
 #'
 #'
 #' @param df \[\code{data.frame(1)}]\cr input data frame.
-#' @param c \[\code{clist(1)} | \code{cmatrix(1)}]\cr correlation list  output from \code{\link{corrp}} or
-#' correlation matrix output from \code{\link{corr_matrix}}.
+#' @param c \[\code{clist(1)} | \code{cmatrix(1)}]\cr correlation list output from the function \code{\link[corrp]{corrp}} 
+#' with class \code{\link[corrp]{clist}} or correlation matrix output 
+#' from \code{\link[corrp]{corr_matrix}} with class \code{\link[corrp]{cmatrix}}.
 #' @param cutoff \[\code{numeric(1)}]\cr A numeric value for the pair-wise absolute correlation cutoff.
 #' The default values is 0.75.
 #' @param col \[\code{character(1)}]\cr choose the column to be used in the correlation matrix
 #' @param isig \[\code{logical(1)}]\cr values that are not statistically significant will
 #' be represented by NA or FALSE in the correlation matrix.
-#' @param ... Additional arguments (TODO).
+#' @param ... Additional arguments.
 #'
 #' @examples
 #'
-#' iris_cor <- corrp(iris)
-#' corr_rm(df = iris, c = iris_cor, cutoff = 0.75, col = "infer.value", isig = FALSE)
+#' iris_clist <- corrp(iris)
+#' iris_cmatrix <- corr_matrix(iris_clist)
+#' corr_rm(df = iris, c = iris_clist, cutoff = 0.75, col = "infer.value", isig = FALSE)
+#' corr_rm(df = iris, c = iris_cmatrix, cutoff = 0.75, col = "infer.value", isig = FALSE)
 #'
 #' @author Igor D.S. Siciliani
 #'
diff --git a/man/corr_rm.Rd b/man/corr_rm.Rd
index abf2329..63cb7cf 100644
--- a/man/corr_rm.Rd
+++ b/man/corr_rm.Rd
@@ -35,10 +35,11 @@ corr_rm(df, c, ...)
 \arguments{
 \item{df}{\[\code{data.frame(1)}]\cr input data frame.}
 
-\item{c}{\[\code{clist(1)} | \code{cmatrix(1)}]\cr correlation list  output from \code{\link{corrp}} or
-correlation matrix output from \code{\link{corr_matrix}}.}
+\item{c}{\[\code{clist(1)} | \code{cmatrix(1)}]\cr correlation list output from the function \code{\link[corrp]{corrp}} 
+with class \code{\link[corrp]{clist}} or correlation matrix output 
+from \code{\link[corrp]{corr_matrix}} with class \code{\link[corrp]{cmatrix}}.}
 
-\item{...}{Additional arguments (TODO).}
+\item{...}{Additional arguments.}
 
 \item{col}{\[\code{character(1)}]\cr choose the column to be used in the correlation matrix}
 
@@ -54,8 +55,10 @@ corrp functions outputs and the caret package function \code{\link[caret]{findCo
 }
 \examples{
 
-iris_cor <- corrp(iris)
-corr_rm(df = iris, c = iris_cor, cutoff = 0.75, col = "infer.value", isig = FALSE)
+iris_clist <- corrp(iris)
+iris_cmatrix <- corr_matrix(iris_clist)
+corr_rm(df = iris, c = iris_clist, cutoff = 0.75, col = "infer.value", isig = FALSE)
+corr_rm(df = iris, c = iris_cmatrix, cutoff = 0.75, col = "infer.value", isig = FALSE)
 
 }
 \author{