Link to website in main vignette

EvolEcolGroup · Nov 9, 2023 · cffda23 · cffda23
1 parent f18bad6
commit cffda23
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/R/tidysdm.R b/R/tidysdm.R
@@ -1,7 +1,23 @@
 #' tidysdm
 #'
 #' This `R` library facilitates the fitting of Species Distribution
-#' Models with `tidymodels`
+#' Models with `tidymodels`.
+#' 
+#' The functionalities of `tidysdm` are described in
+#'  Leonardi et al. (2023) \doi{10.1101/2023.07.24.550358}. Please cite it if you
+#' use `tidysdm` in your research.
+#'
+#' On its dedicated [website](https://evolecolgroup.github.io/tidysdm/), you can find
+#' Articles giving you a step-by-step [overview of the package](https://evolecolgroup.github.io/tidysdm/articles/a0_tidysdm_overview.html),
+#' how to use [`tidysdm` on palaeodata](https://evolecolgroup.github.io/tidysdm/articles/a1_palaeodata_application.html),
+#' examples of [advanced modelling approaches using `tidymodels` features](https://evolecolgroup.github.io/tidysdm/articles/a2_tidymodels_additions.html),
+#' and a [troubleshooting guide for when models fail](https://evolecolgroup.github.io/tidysdm/articles/a3_troubleshooting.html).
+#' There is also a
+#' [development version](https://evolecolgroup.github.io/tidysdm/dev/) of the site
+#' updated for the `dev` version (on the top left, the version number is in
+#' red, and will be in the format x.x.x.9xxx, indicating it is a
+#' development version).
+#'
 #' @docType package
 #' @name tidysdm
 #' @import tidymodels

diff --git a/vignettes/a0_tidysdm_overview.Rmd b/vignettes/a0_tidysdm_overview.Rmd
@@ -26,7 +26,10 @@ ideal framework. `tidysdm` provides a number of wrappers and specialised
 functions to facilitate the fitting of SDM with `tidymodels`.
 
 This article provides an overview of the how `tidysdm` facilitates fitting
-SDMs. As `tidysdm` relies on `tidymodels`, users are advised to familiarise 
+SDMs. Further articles, detailing how to use the package for palaeodata, 
+fitting more complex models and how to troubleshoot models can be found
+on the [`tidisdm` website](https://evolecolgroup.github.io/tidysdm/). 
+As `tidysdm` relies on `tidymodels`, users are advised to familiarise 
 themselves with the introductory
 tutorials on the [`tidymodels` website](https://www.tidymodels.org/start/).