feat: add start-up message

modal-inria · Oct 7, 2023 · ebb2544 · ebb2544
1 parent 3681ee5
commit ebb2544
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 3 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -7,4 +7,5 @@ README.md
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+scripts
 CITATION.cff
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: cfda
 Type: Package
 Title: Categorical Functional Data Analysis
 Version: 0.11.0
-Date: 2023-03-31
+Date: 2023-10-07
 Authors@R: c(person("Cristian", "Preda", role = "aut", email = "cristian.preda@inria.fr"),
              person("Quentin", "Grimonprez", role = c("aut", "cre"), email = "quentingrim@yahoo.fr"),
              person("Vincent", "Vandewalle", role = "ctb", email = "vincent.vandewalle@inria.fr"))

diff --git a/NAMESPACE b/NAMESPACE
@@ -9,6 +9,7 @@ S3method(plot,pt)
 S3method(predict,fmca)
 S3method(print,fmca)
 S3method(summary,fmca)
+export(.onAttach)
 export(compute_duration)
 export(compute_number_jumps)
 export(compute_optimal_encoding)

diff --git a/NEWS b/NEWS
@@ -1,4 +1,4 @@
-v0.11.0 2023-03-31
+v0.11.0 2023-10-07
 - New computation method for U and V matrices
 
 v0.10.1 2022-08-16

diff --git a/R/estimation.R b/R/estimation.R
@@ -32,7 +32,7 @@ estimate_Markov <- function(data) {
   checkData(data)
   ## end check
 
-  # we msut delete the jumps from a state to the itself
+  # we must delete the jumps from a state to the itself
   data <- remove_duplicated_states(data, keep.last = TRUE)
 
   P_est <- prop.table(statetable(data, removeDiagonal = TRUE), margin = 1)

diff --git a/R/zzz.R b/R/zzz.R
@@ -0,0 +1,9 @@
+#' @export
+.onAttach <- function(lib, pkg) {
+  packageStartupMessage(
+    paste(
+      "INFO: Since cfda 0.11, the computing method of compute_optimal_encoding function has changed.",
+      "To use the former one, add the argument: method='parallel'"
+    )
+  )
+}