diff --git a/DESCRIPTION b/DESCRIPTION index 764f080..9694368 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -72,4 +72,4 @@ VignetteBuilder: Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.2.3.9000 diff --git a/NEWS.md b/NEWS.md index c5df540..58ce87f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -6,6 +6,10 @@ Enhancements: * Minor changes to the plotting of formal contexts. * Now the `fc$scale()` function admits a new argument `bg` (default: FALSE) which, if set to TRUE, avoids computing the background knowledge of the scales. +Fixes: + +* Changed the package documentation format to comply with the new roxygen2 _PACKAGE sentinel. + # fcaR 1.2.1 Enhancements: diff --git a/R/fcaR-package.R b/R/fcaR-package.R index df4dc9e..de83c96 100644 --- a/R/fcaR-package.R +++ b/R/fcaR-package.R @@ -1,3 +1,5 @@ + + ## usethis namespace: start #' @useDynLib fcaR, .registration = TRUE ## usethis namespace: end @@ -50,6 +52,6 @@ NULL #' Mora A, Cordero P, Enciso M, Fortes I, Aguilera G (2012). “Closure via functional dependence simplification.” _International Journal of Computer Mathematics_, *89*(4), 510-526. #' Belohlavek R, Cordero P, Enciso M, Mora Á, Vychodil V (2016). “Automated prover for attribute dependencies in data with grades.” _International Journal of Approximate Reasoning_, *70*, 51-67. #' -#' @docType package -#' @name fcaR -NULL +# @docType package +#' @keywords internal +"_PACKAGE" diff --git a/cran-comments.md b/cran-comments.md index 14ef60c..b575585 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,7 +1,7 @@ ## Test environments * local R installation, on MACOS BigSur 11.4, R version 4.3.0 (2023-04-21), platform: aarch64-apple-darwin20 (64-bit) * win-builder (devel) -* macos-latest (release), windows-latest (release), ubuntu-20.04 (release) via GitHub actions. +* windows-latest (release), ubuntu-20.04 (release) via GitHub actions. * Ubuntu Linux 20.04.1 LTS, R-release, GCC on R-hub. * local R with valgrind using docker * Default platforms using devtools::check_rhub(). diff --git a/man/fcaR.Rd b/man/fcaR-package.Rd similarity index 85% rename from man/fcaR.Rd rename to man/fcaR-package.Rd index 5a76660..56adeae 100644 --- a/man/fcaR.Rd +++ b/man/fcaR-package.Rd @@ -1,8 +1,9 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/fcaR-package.R \docType{package} -\name{fcaR} +\name{fcaR-package} \alias{fcaR} +\alias{fcaR-package} \title{fcaR: Tools for Formal Concept Analysis} \description{ The aim of this package is to provide tools to perform fuzzy formal concept analysis (FCA) from within R. @@ -49,3 +50,28 @@ Hahsler M, Grun B, Hornik K (2005). “arules - a computational environment for Mora A, Cordero P, Enciso M, Fortes I, Aguilera G (2012). “Closure via functional dependence simplification.” \emph{International Journal of Computer Mathematics}, \emph{89}(4), 510-526. Belohlavek R, Cordero P, Enciso M, Mora Á, Vychodil V (2016). “Automated prover for attribute dependencies in data with grades.” \emph{International Journal of Approximate Reasoning}, \emph{70}, 51-67. } +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/Malaga-FCA-group/fcaR} + \item Report bugs at \url{https://github.com/Malaga-FCA-group/fcaR/issues} +} + +} +\author{ +\strong{Maintainer}: Domingo Lopez Rodriguez \email{dominlopez@uma.es, neuroimaginador@gmail.com} (\href{https://orcid.org/0000-0002-0172-1585}{ORCID}) + +Authors: +\itemize{ + \item Angel Mora \email{amorabonilla@gmail.com} + \item Jesus Dominguez + \item Ana Villalon +} + +Other contributors: +\itemize{ + \item Ian Johnson [contributor] +} + +} +\keyword{internal}