From 9b80f8e6c296c81dda5dbd0cd024f9889ac24f9b Mon Sep 17 00:00:00 2001 From: pr0m1th3as Date: Sun, 28 Jan 2024 11:43:46 +0200 Subject: [PATCH] fix docstrings --- inst/Clustering/CalinskiHarabaszEvaluation.m | 2 +- inst/Clustering/ClusterCriterion.m | 2 +- inst/Clustering/DaviesBouldinEvaluation.m | 2 +- inst/Clustering/GapEvaluation.m | 2 +- inst/Clustering/SilhouetteEvaluation.m | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/inst/Clustering/CalinskiHarabaszEvaluation.m b/inst/Clustering/CalinskiHarabaszEvaluation.m index 3ea363dd..61870ed5 100644 --- a/inst/Clustering/CalinskiHarabaszEvaluation.m +++ b/inst/Clustering/CalinskiHarabaszEvaluation.m @@ -35,10 +35,10 @@ ## ## The best solution according to the Calinski-Harabasz criterion is the one ## that scores the highest value. - ## @end deftypefn ## ## @seealso{evalclusters, ClusterCriterion, DaviesBouldinEvaluation, ## GapEvaluation, SilhouetteEvaluation} + ## @end deftypefn properties (GetAccess = public, SetAccess = private) diff --git a/inst/Clustering/ClusterCriterion.m b/inst/Clustering/ClusterCriterion.m index abb24ece..a95a0d1f 100644 --- a/inst/Clustering/ClusterCriterion.m +++ b/inst/Clustering/ClusterCriterion.m @@ -72,10 +72,10 @@ ## clusters. ## ## @end table - ## @end deftypefn ## ## @seealso{evalclusters, CalinskiHarabaszEvaluation, DaviesBouldinEvaluation, ## GapEvaluation, SilhouetteEvaluation} + ## @end deftypefn properties (Access = public) ## public properties diff --git a/inst/Clustering/DaviesBouldinEvaluation.m b/inst/Clustering/DaviesBouldinEvaluation.m index 8031db7b..d560ef5d 100644 --- a/inst/Clustering/DaviesBouldinEvaluation.m +++ b/inst/Clustering/DaviesBouldinEvaluation.m @@ -33,10 +33,10 @@ ## ## The best solution according to the Davies-Bouldin criterion is the one ## that scores the lowest value. - ## @end deftypefn ## ## @seealso{evalclusters, ClusterCriterion, CalinskiHarabaszEvaluation, ## GapEvaluation, SilhouetteEvaluation} + ## @end deftypefn properties (GetAccess = public, SetAccess = private) diff --git a/inst/Clustering/GapEvaluation.m b/inst/Clustering/GapEvaluation.m index 283ad818..ae459b11 100644 --- a/inst/Clustering/GapEvaluation.m +++ b/inst/Clustering/GapEvaluation.m @@ -66,10 +66,10 @@ ## max gap value; when the search method is @code{firstMaxSE}, the chosen ## gap value is the first one which is inside a standard error from the next ## gap value. - ## @end deftypefn ## ## @seealso{evalclusters, ClusterCriterion, CalinskiHarabaszEvaluation, ## DaviesBouldinEvaluation, SilhouetteEvaluation} + ## @end deftypefn properties (GetAccess = public, SetAccess = private) B = 0; # number of reference datasets diff --git a/inst/Clustering/SilhouetteEvaluation.m b/inst/Clustering/SilhouetteEvaluation.m index 8aa4cf48..c6e02284 100644 --- a/inst/Clustering/SilhouetteEvaluation.m +++ b/inst/Clustering/SilhouetteEvaluation.m @@ -45,10 +45,10 @@ ## ## The best solution according to the silhouette criterion is the one ## that scores the highest average silhouette value. - ## @end deftypefn ## ## @seealso{evalclusters, ClusterCriterion, CalinskiHarabaszEvaluation, ## DaviesBouldinEvaluation, GapEvaluation} + ## @end deftypefn properties (GetAccess = public, SetAccess = private) Distance = ""; # pdist parameter