Updated Roxygen.

mhahsler · Mar 1, 2024 · ccf0236 · ccf0236
1 parent 30e56a1
commit ccf0236
Show file tree

Hide file tree

Showing 31 changed files with 113 additions and 47 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: arules
-Version: 1.7-7
-Date: 2023-11-28
+Version: 1.7-7-1
+Date: 2024-xx-xx
 Title: Mining Association Rules and Frequent Itemsets
 Authors@R: c(
     person("Michael", "Hahsler", role = c("aut", "cre", "cph"),
@@ -29,10 +29,11 @@ Copyright: The source code for Apriori and Eclat was obtained from
     All other code is Copyright (C) Michael Hahsler, Christian Buchta,
     Bettina Gruen and Kurt Hornik.
 Encoding: UTF-8
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Roxygen: list(markdown = TRUE)
 Collate: 
     'AAADefs.R'
+    'AAA_arules-package.R'
     'Adult.R'
     'itemMatrix.R'
     'associations.R'

diff --git a/NAMESPACE b/NAMESPACE
@@ -120,6 +120,9 @@ exportMethods(
   "dissimilarity"
 )
 
+export("plot.itemMatrix",
+       "plot.associations"
+)
 S3method(plot, associations)
 S3method(plot, itemMatrix)
 

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,5 @@
+# arules 1.7-7-1 (xx/xx/2024)
+
 # arules 1.7-7 (11/28/2023)
 
 ## Changes

diff --git a/R/AAA_arules-package.R b/R/AAA_arules-package.R
@@ -0,0 +1,8 @@
+#' @keywords internal
+#'
+#' @section Key functions and Classes:
+#' - Mining Algorithms: [apriori()], [eclat()]
+#' - Classes: [transactions], [rules], [itemsets]
+#'
+#' @useDynLib arules, .registration=TRUE
+"_PACKAGE"
diff --git a/R/apriori.R b/R/apriori.R
@@ -144,7 +144,7 @@
 #' # since ... gets automatically added to parameter, we can also write the 
 #' #  same call shorter:
 #' apriori(Adult, supp = 0.5, conf = 0.9, target = "rules")
-#' @export apriori
+#' @export
 apriori <-
   function(data,
     parameter = NULL,

diff --git a/R/plot.R b/R/plot.R
@@ -24,9 +24,10 @@
 NULL
 
 ### produce a better error message for plot of associations
+#' @export
 plot.associations <- function(x, ...) stop("Needed package 'arulesViz' not installed or loaded!")
 
-### call image for itemMatrix and transactions 
+#' @export
 plot.itemMatrix <- function(x, ...) {
   warning("Use image() instead of plot().")
   image(x, ...)

diff --git a/R/support.R b/R/support.R
@@ -79,7 +79,7 @@
 #'
 #' ## count support in the database
 #' support(items(itemsets), Income)
-#' @export support
+#' @export 
 setGeneric("support",
   function(x, transactions, ...)
     standardGeneric("support"))

diff --git a/man/abbreviate.Rd b/man/abbreviate.Rd
diff --git a/man/arules-package.Rd b/man/arules-package.Rd
diff --git a/man/c.Rd b/man/c.Rd
diff --git a/man/crossTable.Rd b/man/crossTable.Rd
diff --git a/man/duplicated.Rd b/man/duplicated.Rd
diff --git a/man/extract.Rd b/man/extract.Rd
diff --git a/man/hierarchy.Rd b/man/hierarchy.Rd
diff --git a/man/image.Rd b/man/image.Rd
diff --git a/man/inspect.Rd b/man/inspect.Rd
diff --git a/man/is.superset.Rd b/man/is.superset.Rd
diff --git a/man/itemFrequency.Rd b/man/itemFrequency.Rd
diff --git a/man/itemFrequencyPlot.Rd b/man/itemFrequencyPlot.Rd
diff --git a/man/itemMatrix-class.Rd b/man/itemMatrix-class.Rd
diff --git a/man/match.Rd b/man/match.Rd
diff --git a/man/merge.Rd b/man/merge.Rd
diff --git a/man/random.transactions.Rd b/man/random.transactions.Rd
diff --git a/man/sample.Rd b/man/sample.Rd