update examplesIf

tidymodels · Nov 9, 2024 · 827d61f · 827d61f
1 parent 02bb9b9
commit 827d61f
Show file tree

Hide file tree

Showing 40 changed files with 52 additions and 30 deletions.
diff --git a/R/clean_levels.R b/R/clean_levels.R
@@ -41,7 +41,7 @@
 #'   [recipes::step_unknown()], [recipes::step_novel()], [recipes::step_other()]
 #' @family Steps for Text Cleaning
 #'
-#' @examplesIf rlang::is_installed("janitor")
+#' @examplesIf rlang::is_installed(c("modeldata", "janitor"))
 #' library(recipes)
 #' library(modeldata)
 #' data(Smithsonian)

diff --git a/R/dummy_hash.R b/R/dummy_hash.R
@@ -72,7 +72,7 @@
 #' @seealso [recipes::step_dummy()]
 #' @family Steps for Numeric Variables From Characters
 #'
-#' @examplesIf all(c("text2vec", "data.table") %in% rownames(installed.packages()))
+#' @examplesIf all(c("modeldata", "text2vec", "data.table") %in% rownames(installed.packages()))
 #' \dontshow{library(data.table)}
 #' \dontshow{data.table::setDTthreads(2)}
 #' \dontshow{Sys.setenv("OMP_NUM_THREADS" = 1)}

diff --git a/R/lda.R b/R/lda.R
@@ -38,7 +38,7 @@
 #'
 #' @family Steps for Numeric Variables From Tokens
 #'
-#' @examplesIf all(c("text2vec", "data.table") %in% rownames(installed.packages()))
+#' @examplesIf all(c("modeldata", "text2vec", "data.table") %in% rownames(installed.packages()))
 #' \dontshow{library(data.table)}
 #' \dontshow{data.table::setDTthreads(2)}
 #' \dontshow{Sys.setenv("OMP_THREAD_LIMIT" = 2)}

diff --git a/R/ngram.R b/R/ngram.R
@@ -49,7 +49,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Token Modification
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/sequence_onehot.R b/R/sequence_onehot.R
@@ -52,7 +52,7 @@
 #'
 #' @family Steps for Numeric Variables From Characters
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/show_tokens.R b/R/show_tokens.R
@@ -12,7 +12,7 @@
 #' @return A list of character vectors
 #' @export
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' text_tibble <- tibble(text = c("This is words", "They are nice!"))
 #'
 #' recipe(~text, data = text_tibble) %>%

diff --git a/R/stem.R b/R/stem.R
@@ -42,7 +42,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Token Modification
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/stopwords.R b/R/stopwords.R
@@ -49,7 +49,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Token Modification
 #'
-#' @examplesIf rlang::is_installed("stopwords")
+#' @examplesIf rlang::is_installed(c("modeldata", "stopwords"))
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/textfeature.R b/R/textfeature.R
@@ -42,7 +42,7 @@
 #'
 #' @family Steps for Numeric Variables From Characters
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/texthash.R b/R/texthash.R
@@ -62,7 +62,7 @@
 #'   [step_text_normalization()] to perform text normalization.
 #' @family Steps for Numeric Variables From Tokens
 #'
-#' @examplesIf all(c("text2vec", "data.table") %in% rownames(installed.packages()))
+#' @examplesIf all(c("modeldata", "text2vec", "data.table") %in% rownames(installed.packages()))
 #' \dontshow{library(data.table)}
 #' \dontshow{data.table::setDTthreads(2)}
 #' \dontshow{Sys.setenv("OMP_THREAD_LIMIT" = 2)}

diff --git a/R/tf.R b/R/tf.R
@@ -74,7 +74,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Numeric Variables From Tokens
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' \donttest{
 #' library(recipes)
 #' library(modeldata)

diff --git a/R/tfidf.R b/R/tfidf.R
@@ -68,7 +68,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Numeric Variables From Tokens
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' \donttest{
 #' library(recipes)
 #' library(modeldata)

diff --git a/R/tokenfilter.R b/R/tokenfilter.R
@@ -64,7 +64,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Token Modification
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/tokenize.R b/R/tokenize.R
@@ -202,7 +202,7 @@
 #' @seealso [step_untokenize()] to untokenize.
 #' @family Steps for Tokenization
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/tokenize_bpe.R b/R/tokenize_bpe.R
@@ -42,7 +42,7 @@
 #' @seealso [step_untokenize()] to untokenize.
 #' @family Steps for Tokenization
 #'
-#' @examplesIf rlang::is_installed("tokenizers.bpe")
+#' @examplesIf rlang::is_installed(c("modeldata", "tokenizers.bpe"))
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/tokenize_sentencepiece.R b/R/tokenize_sentencepiece.R
@@ -41,7 +41,7 @@
 #' @seealso [step_untokenize()] to untokenize.
 #' @family Steps for Tokenization
 #'
-#' @examplesIf rlang::is_installed("sentencepiece")
+#' @examplesIf rlang::is_installed(c("modeldata", "sentencepiece"))
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/tokenize_wordpiece.R b/R/tokenize_wordpiece.R
@@ -35,7 +35,7 @@
 #' @seealso [step_untokenize()] to untokenize.
 #' @family Steps for Tokenization
 #'
-#' @examplesIf rlang::is_installed("wordpiece")
+#' @examplesIf rlang::is_installed(c("modeldata", "wordpiece"))
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/tokenlist.R b/R/tokenlist.R
@@ -9,7 +9,7 @@
 #'
 #' @return a [tokenlist] object.
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' abc <- list(letters, LETTERS)
 #' tokenlist(abc)
 #'

diff --git a/R/tokenmerge.R b/R/tokenmerge.R
@@ -33,7 +33,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Token Modification
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/R/untokenize.R b/R/untokenize.R
@@ -37,7 +37,7 @@
 #' @seealso [step_tokenize()] to turn characters into [`tokens`][tokenlist()]
 #' @family Steps for Un-Tokenization
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(modeldata)
 #' data(tate_text)

diff --git a/man/show_tokens.Rd b/man/show_tokens.Rd
diff --git a/man/step_clean_levels.Rd b/man/step_clean_levels.Rd
diff --git a/man/step_dummy_hash.Rd b/man/step_dummy_hash.Rd
diff --git a/man/step_lda.Rd b/man/step_lda.Rd
diff --git a/man/step_ngram.Rd b/man/step_ngram.Rd
diff --git a/man/step_sequence_onehot.Rd b/man/step_sequence_onehot.Rd
diff --git a/man/step_stem.Rd b/man/step_stem.Rd
diff --git a/man/step_stopwords.Rd b/man/step_stopwords.Rd
diff --git a/man/step_textfeature.Rd b/man/step_textfeature.Rd
diff --git a/man/step_texthash.Rd b/man/step_texthash.Rd
diff --git a/man/step_tf.Rd b/man/step_tf.Rd
diff --git a/man/step_tfidf.Rd b/man/step_tfidf.Rd
diff --git a/man/step_tokenfilter.Rd b/man/step_tokenfilter.Rd
diff --git a/man/step_tokenize.Rd b/man/step_tokenize.Rd
diff --git a/man/step_tokenize_bpe.Rd b/man/step_tokenize_bpe.Rd
diff --git a/man/step_tokenize_sentencepiece.Rd b/man/step_tokenize_sentencepiece.Rd
diff --git a/man/step_tokenize_wordpiece.Rd b/man/step_tokenize_wordpiece.Rd