Add attach message

spsanderson · Jul 16, 2024 · 7eba6c4 · 7eba6c4
1 parent e4852ea
commit 7eba6c4
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 4 deletions.
diff --git a/R/gen-geom-brown-motion.R b/R/gen-geom-brown-motion.R
@@ -43,7 +43,7 @@
 #' of class matrix will be returned.
 #'
 #' @examples
-#' ts_geometric_brownian_motion()
+#' geometric_brownian_motion()
 #'
 #' @return
 #' A tibble/matrix

diff --git a/R/zzz.R b/R/zzz.R
@@ -0,0 +1,18 @@
+# On library attachment, print message to user.
+.onAttach <- function(libname, pkgname) {
+
+  msg <- paste0(
+    "\n",
+    "== Welcome to RandomWalker ========================================================",
+    "\nIf you find this package useful, please leave a star: ",
+    "\n   https://github.com/spsanderson/RandomWalker'",
+    "\n",
+    "\nIf you encounter a bug or want to request an enhancement please file an issue at:",
+    "\n   https://github.com/spsanderson/RandomWalker/issues",
+    "\n",
+    "\nThank you for using RandomWalker"
+  )
+
+  packageStartupMessage(msg)
+
+}
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -4,7 +4,6 @@ template:
   bootswatch: flatly
   ganalytics: G-BSLLH3X96M
 
-
 navbar:
   title: "RandomWalker"
   left:

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.1.0
 pkgdown_sha: ~
 articles:
   getting-started: getting-started.html
-last_built: 2024-07-13T12:59Z
+last_built: 2024-07-16T02:17Z
 urls:
   reference: https://www.spsanderson.com/RandomWalker/reference
   article: https://www.spsanderson.com/RandomWalker/articles
diff --git a/man/geometric_brownian_motion.Rd b/man/geometric_brownian_motion.Rd
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ template: @@
       bootswatch: flatly
       ganalytics: G-BSLLH3X96M
     navbar:
       title: "RandomWalker"
       left:
@@ Expand Down @@