Skip to content

Commit

Permalink
fixing package doc as mentionned in r-lib/roxygen2#1491
Browse files Browse the repository at this point in the history
  • Loading branch information
jchiquet committed Oct 19, 2023
1 parent 8e7a75c commit 7b35af4
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 13 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: aricode
Type: Package
Title: Efficient Computations of Standard Clustering Comparison Measures
Version: 1.0.2
Version: 1.0.3
Authors@R: c(
person("Julien", "Chiquet", role = c("aut", "cre"), email = "[email protected]",
comment = c(ORCID = "0000-0002-3629-3429")),
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## aricode 1.0-3 (2023-10-19)

- minor fix in package documentation due to evolution of roxygen2 7.0.0 <https://github.com/r-lib/roxygen2/issues/1491>.

## aricode 1.0-2 (2022-12-14)

- fix a serious bug in the AMI function pointed by Florent Bersani
Expand Down
11 changes: 9 additions & 2 deletions R/aricode-package.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
#' @keywords internal
"_PACKAGE"

#' aricode
#'
#' A package for efficient computations of standard clustering comparison measures. Most of the available measures are described in the paper of Vinh et al, JMLR, 2009 (see reference below).
Expand All @@ -24,8 +27,12 @@
#' @author Martina Sundqvist \email{martina.sundqvist@@agroparistech.fr}
#' @references Nguyen Xuan Vinh, Julien Epps, and James Bailey. "Information theoretic measures for clusterings comparison: Variants, properties, normalization and correction for chance." Journal of Machine Learning Research 11.Oct (2010): 2837-2854. as described in Vinh et al (2009)
#' @seealso \code{\link{ARI}}, \code{\link{RI}}, \code{\link{NID}}, \code{\link{NVI}}, \code{\link{AMI}}, \code{\link{NMI}}, \code{\link{entropy}}, \code{\link{clustComp}}
#' @docType package
#' @name aricode
#' @name aricode-package

# The following block is used by usethis to automatically manage
# roxygen namespace tags. Modify with care!
## usethis namespace: start
#' @useDynLib aricode
#' @importFrom Rcpp sourceCpp
## usethis namespace: end
NULL
19 changes: 11 additions & 8 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
al
AMI
ARI
clustComp
doi
EMI
entropies
CMD
Epps
et
JMLR
Lifecycle
MARIraw
mclust
NID
NMI
NVI
sortPairs
ORCID
SortPairs
Vinh
Xuan
al
clustComp
doi
entropies
et
mclust
radix
roxygen
sortPairs
30 changes: 28 additions & 2 deletions man/aricode.Rd → man/aricode-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7b35af4

Please sign in to comment.