replace all \donttest with another strategy

turtletopia · Jan 26, 2025 · 9189d8a · 9189d8a
1 parent e46bd8b
commit 9189d8a
Show file tree

Hide file tree

Showing 57 changed files with 87 additions and 168 deletions.
diff --git a/R/bioc-dependencies.R b/R/bioc-dependencies.R
@@ -11,16 +11,14 @@
 #' * `version` (minimum version requirement or `NA` if none),
 #' * `type` (dependency type, e.g. `"Imports"`).
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_bioc_dependencies("Biostrings")
 #'
 #' # Will dependencies change?
 #' wood_bioc_dependencies("Biostrings", "devel")
 #' # And what about dependencies in the past?
 #' wood_bioc_dependencies("Biostrings", "2.10")
 #' wood_bioc_dependencies("Biostrings", "1.8")
-#' }
 #'
 #' @family bioc
 #' @family dependencies

diff --git a/R/bioc-packages.R b/R/bioc-packages.R
@@ -8,8 +8,7 @@
 #'
 #' @return A character vector of available packages.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' print(wood_bioc_packages(), max = 15)
 #' # is the same as
 #' print(wood_bioc_packages("release"), max = 15)
@@ -20,7 +19,6 @@
 #' print(wood_bioc_packages("3.9"), max = 15)
 #' # The oldest available version is 1.8:
 #' wood_bioc_packages("1.8")
-#' }
 #'
 #' @family bioc
 #' @family packages

diff --git a/R/bioc-releases.R b/R/bioc-releases.R
@@ -5,10 +5,8 @@
 #'
 #' @return A character vector, where each element is a Bioconductor release.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_bioc_releases()
-#' }
 #'
 #' @family bioc
 #' @export

diff --git a/R/bioc-version.R b/R/bioc-version.R
@@ -8,15 +8,13 @@
 #'
 #' @return A single string with a version code.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_bioc_version("Biostrings")
 #'
 #' # What's coming next?
 #' wood_bioc_version("Biostrings", release = "devel")
 #' # Can query releases as old as 1.8:
 #' wood_bioc_version("Biostrings", release = "1.8")
-#' }
 #'
 #' @family bioc
 #' @family versions

diff --git a/R/cran-dependencies.R b/R/cran-dependencies.R
@@ -12,11 +12,9 @@
 #' * `version` (minimum version requirement or `NA` if none),
 #' * `type` (dependency type, e.g. `"Imports"`).
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_cran_dependencies("deepdep")
 #' wood_cran_dependencies("ggplot2", version = "3.4.0")
-#' }
 #'
 #' @family cran
 #' @family dependencies

diff --git a/R/cran-latest.R b/R/cran-latest.R
@@ -7,10 +7,8 @@
 #'
 #' @return A single string with a version code.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_cran_latest("versionsort")
-#' }
 #'
 #' @family cran
 #' @family versions

diff --git a/R/cran-packages.R b/R/cran-packages.R
@@ -5,10 +5,8 @@
 #'
 #' @return A character vector of available packages.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' print(wood_cran_packages(), max = 15)
-#' }
 #'
 #' @family cran
 #' @family packages

diff --git a/R/cran-versions.R b/R/cran-versions.R
@@ -7,10 +7,8 @@
 #'
 #' @return A character vector of version codes.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_cran_versions("versionsort")
-#' }
 #'
 #' @family cran
 #' @family versions

diff --git a/R/deps-squash.R b/R/deps-squash.R
@@ -10,11 +10,9 @@
 #' @return A `data.frame` object similar to these returned by `_dependencies`
 #' functions, but with additional column named `origin`.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' deps <- wood_dependencies(c("versionsort", "deepdep", "gglgbtq"))
 #' squash(deps)
-#' }
 #'
 #' @export
 squash <- function(object) {

diff --git a/R/github-dependencies.R b/R/github-dependencies.R
@@ -14,11 +14,9 @@
 #' * `version` (minimum version requirement or `NA` if none),
 #' * `type` (dependency type, e.g. `"Imports"`).
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_github_dependencies("gglgbtq", "turtletopia")
 #' wood_github_dependencies("versionsort", "turtletopia", tag = "v1.0.0")
-#' }
 #'
 #' @family github
 #' @family dependencies

diff --git a/R/github-latest.R b/R/github-latest.R
@@ -9,15 +9,13 @@
 #'
 #' @return A character vector of version codes.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' # Latest version code is returned
 #' wood_github_latest("gglgbtq", "turtletopia")
 #'
 #' # To get the latest *tagged* version code instead, use:
 #' codes <- wood_github_versions("gglgbtq", "turtletopia")
 #' versionsort::ver_latest(codes)
-#' }
 #'
 #' @family github
 #' @family versions

diff --git a/R/github-packages.R b/R/github-packages.R
@@ -10,12 +10,10 @@
 #'
 #' @return A character vector of available packages.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_github_packages("turtletopia")
 #' # I moved most my packages to turtletopia
 #' wood_github_packages("ErdaradunGaztea", include_forks = TRUE)
-#' }
 #'
 #' @family github
 #' @family packages

diff --git a/R/github-tags.R b/R/github-tags.R
@@ -10,12 +10,10 @@
 #'
 #' @return A character vector of repository tags.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_github_tags("gglgbtq", "turtletopia")
 #' # Sometimes there are no tags (yet?)
 #' wood_github_tags("ggpizza", "turtletopia")
-#' }
 #'
 #' @family github
 #' @export

diff --git a/R/github-versions.R b/R/github-versions.R
@@ -8,10 +8,8 @@
 #'
 #' @return A character vector of version codes.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_github_versions("versionsort", "turtletopia")
-#' }
 #'
 #' @family github
 #' @family versions

diff --git a/R/gitlab-dependencies.R b/R/gitlab-dependencies.R
@@ -14,11 +14,9 @@
 #' * `version` (minimum version requirement or `NA` if none),
 #' * `type` (dependency type, e.g. `"Imports"`).
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_gitlab_dependencies("limonaid", "r-packages")
 #' wood_gitlab_dependencies("rock", "r-packages", tag = "0.6.3")
-#' }
 #'
 #' @family gitlab
 #' @family dependencies

diff --git a/R/gitlab-latest.R b/R/gitlab-latest.R
@@ -9,15 +9,13 @@
 #'
 #' @return A character vector of version codes.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' # Latest version code is returned
 #' wood_gitlab_latest("rock", "r-packages")
 #'
 #' # To get the latest *tagged* version code instead, use:
 #' codes <- wood_gitlab_versions("rock", "r-packages")
 #' versionsort::ver_latest(codes)
-#' }
 #'
 #' @family gitlab
 #' @family versions

diff --git a/R/gitlab-packages.R b/R/gitlab-packages.R
@@ -10,13 +10,11 @@
 #'
 #' @return A character vector of available packages.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_gitlab_packages("r-packages")
 #' # The function takes care of differentiating
 #' # between users and groups internally
 #' wood_gitlab_packages("matherion")
-#' }
 #'
 #' @family gitlab
 #' @family packages

diff --git a/R/gitlab-tags.R b/R/gitlab-tags.R
@@ -10,10 +10,8 @@
 #'
 #' @return A character vector of repository tags.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_gitlab_tags("rock", "r-packages")
-#' }
 #'
 #' @family gitlab
 #' @export

diff --git a/R/gitlab-versions.R b/R/gitlab-versions.R
@@ -8,10 +8,8 @@
 #'
 #' @return A character vector of version codes.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_gitlab_versions("rock", "r-packages")
-#' }
 #'
 #' @family gitlab
 #' @family versions

diff --git a/R/runiverse-dependencies.R b/R/runiverse-dependencies.R
@@ -11,11 +11,9 @@
 #' * `version` (minimum version requirement or `NA` if none),
 #' * `type` (dependency type, e.g. `"Imports"`).
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_runiverse_dependencies("targets")
 #' wood_runiverse_dependencies("ggplot2", universe = "tidyverse")
-#' }
 #'
 #' @family runiverse
 #' @family dependencies

diff --git a/R/runiverse-packages.R b/R/runiverse-packages.R
@@ -8,11 +8,9 @@
 #'
 #' @return A character vector of available packages.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_runiverse_packages()
 #' wood_runiverse_packages("tidyverse")
-#' }
 #'
 #' @family runiverse
 #' @family packages

diff --git a/R/runiverse-version.R b/R/runiverse-version.R
@@ -8,11 +8,9 @@
 #'
 #' @return A single string with a version code.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_runiverse_version("targets")
 #' wood_runiverse_version("ggplot2", universe = "tidyverse")
-#' }
 #'
 #' @family runiverse
 #' @family versions

diff --git a/R/url-dependencies.R b/R/url-dependencies.R
@@ -11,10 +11,8 @@
 #' * `version` (minimum version requirement or `NA` if none),
 #' * `type` (dependency type, e.g. `"Imports"`).
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_url_dependencies("tidystringdist", repository = "https://colinfay.me")
-#' }
 #'
 #' @family url
 #' @family dependencies

diff --git a/R/url-packages.R b/R/url-packages.R
@@ -9,12 +9,10 @@
 #'
 #' @return A character vector of available packages.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_url_packages("https://colinfay.me")
 #' # Trailing slashes are removed
 #' wood_url_packages("https://colinfay.me/")
-#' }
 #'
 #' @family url
 #' @family packages

diff --git a/R/url-version.R b/R/url-version.R
@@ -8,10 +8,8 @@
 #'
 #' @return A single string with a version code.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_url_version("dockerfiler", repository = "https://colinfay.me")
-#' }
 #'
 #' @family url
 #' @family versions

diff --git a/R/utils-examples.R b/R/utils-examples.R
@@ -0,0 +1,3 @@
+is_cran_check <- function() {
+  !identical(Sys.getenv("NOT_CRAN"), "true") && Sys.getenv("_R_CHECK_PACKAGE_NAME_", "") != ""
+}
diff --git a/R/wood-dependencies.R b/R/wood-dependencies.R
@@ -12,8 +12,7 @@
 #' * `version` (minimum version requirement or `NA` if none),
 #' * `type` (dependency type, e.g. `"Imports"`).
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_dependencies("stats", "core")
 #' # Multiple packages are also possible:
 #' wood_dependencies(
@@ -22,7 +21,6 @@
 #' )
 #' # By default, only CRAN is queried:
 #' wood_dependencies("versionsort")
-#' }
 #'
 #' @family wood
 #' @family dependencies

diff --git a/R/wood-packages.R b/R/wood-packages.R
@@ -7,13 +7,11 @@
 #'
 #' @return A character vector of available packages.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' print(wood_packages(c("local#all", "[email protected]", "cran", "core")), max = 15)
 #' wood_packages(c("https://colinfay.me", "runiverse@turtletopia"))
 #' # By default, only CRAN is queried:
 #' print(wood_packages(), max = 15)
-#' }
 #'
 #' @family wood
 #' @family packages

diff --git a/R/wood-versions.R b/R/wood-versions.R
@@ -9,8 +9,7 @@
 #' @return A list named after queried packages, each element being a character
 #' vector of version codes.
 #'
-#' @examples
-#' \donttest{
+#' @examplesIf !woodendesc:::is_cran_check()
 #' wood_versions("woodendesc", c("local#all", "runiverse@turtletopia"))
 #' # Multiple packages are also possible:
 #' wood_versions(
@@ -19,7 +18,6 @@
 #' )
 #' # By default, only CRAN is queried:
 #' wood_versions("versionsort")
-#' }
 #'
 #' @family wood
 #' @family versions