update for CRAN package documentation.

CRAN submission of v2.5.2
EricArcher · Aug 23, 2023 · ac6eb28 · ac6eb28
1 parent c59b184
commit ac6eb28
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 8 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -9,4 +9,5 @@ tar.gz$
 .gitignore
 ^appveyor\.yml$
 ^\.github$
-.DS_Store
+.DS_Store
+^revdep$
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,5 @@
 rfPermute.Rcheck
 rfPermute test.R
 /_devel
-rfPermute.Rproj
+rfPermute.Rproj
+/revdep
diff --git a/R/rfPermute_package.R b/R/rfPermute_package.R
@@ -1,7 +1,10 @@
+#' \code{rfPermute} package
+#' 
+#' Random Forest Predictor Importance Significance and Model Diagnostics.
+#' 
+#' @aliases rfPermute-package
 #' @docType package
 #' @name rfPermute_package 
-#' @title rfPermute model object
-#' @description Container for rfPermute results
 #' 
 #' @importFrom randomForest randomForest
 #' @importFrom rlang .data

diff --git a/README.md b/README.md
@@ -59,11 +59,14 @@ devtools::install_github('EricArcher/rfPermute')
 
 ## Changelog
 
-### version 2.5.2 (devel)
+### version 2.5.3 (devel)
+
+### version 2.5.2 (CRAN)
 
 * fixed bug in plotImportance heatmap to now properly choose top rather than bottom `n` predictors.
+* update package documentation for CRAN
 
-### version 2.5.1 (CRAN)
+### version 2.5.1
 
 * added `pct.correct` argument to `plotTrace()`. Default is now to have y-axis as 1 - OOB error rate.
 

diff --git a/man/rfPermute_package.Rd b/man/rfPermute_package.Rd