raymolecule v0.5.3: Add pkgdown helper function to only run some code…

… in pkgdown during CRAN check

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: raymolecule
 Type: Package
 Title: Parse and Render Molecular Structures in 3D
-Version: 0.5.2
+Version: 0.5.3
 Date: 2024-2-18
 Authors@R: c(person("Tyler", "Morgan-Wall", email = "[email protected]",
     role = c("aut", "cph", "cre"), comment = c(ORCID = "0000-0002-3131-3814")))

NAMESPACE

@@ -9,6 +9,7 @@ export(get_molecule)
 export(read_pdb)
 export(read_sdf)
 export(render_model)
+export(run_documentation)
 importFrom(magrittr,"%>%")
 importFrom(rayrender,add_object)
 importFrom(rayrender,glossy)

R/get_molecule.R

@@ -8,28 +8,33 @@
 #' @export
 #'
 #' @examples
-#' \donttest{
+#' if(run_documentation()) {
 #' get_molecule("caffeine") %>%
 #'   generate_full_scene() %>%
 #'   render_model()
-#'
+#' }
+#' if(run_documentation()) {
 #' #estradiol (aka estrogen)
 #' get_molecule(5757) %>%
 #'   generate_full_scene() %>%
 #'   render_model()
-#'
+#' }
+#' if(run_documentation()) {
 #' get_molecule("testosterone") %>%
 #'   generate_full_scene() %>%
 #'   render_model()
-#'
+#' }
+#' if(run_documentation()) {
 #' get_molecule("aspirin") %>%
 #'   generate_full_scene() %>%
 #'   render_model()
-#'
+#' }
+#' if(run_documentation()) {
 #' get_molecule("rutoside") %>%
 #'   generate_full_scene() %>%
 #'   render_model()
-#'
+#' }
+#' if(run_documentation()) {
 #' #If the 3D SDF doesn't exist, this function will pull the 2D SDF and inform the user
 #' get_molecule("cyanocobalamin") %>%
 #'   generate_full_scene() %>%

R/run_documentation.R

@@ -0,0 +1,13 @@
+#' @title Run Documentation
+#'
+#' @description This function determines if the examples are being run in pkgdown. It is not meant to be called by the user.
+#'
+#' @export
+#'
+#' @return Boolean value.
+#' @examples
+#' # See if the documentation should be run.
+#' run_documentation()
+run_documentation = function() {
+  return(identical(Sys.getenv("IN_PKGDOWN"), "true"))
+}

_pkgdown.yml

@@ -21,6 +21,10 @@ reference:
     desc: "Function to get included example data."
     contents:
       - starts_with("get")
+  - title: "pkgdown utils"
+    desc: "Internal but must be exported to meet CRAN guidelines"
+    contents:
+      - starts_with("run")
 
 navbar:
   title: "raymolecule"