Skip to content

Commit 51e1774

Browse files
EmilHvitfeldtEmilHvitfeldt
authored
Merge pull request #261 from tidymodels/tidy-pkgdown
have ?tidy.step_* point to step_*
2 parents 3c105ad + ec1aa90 commit 51e1774

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+81
-160
lines changed

‎DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ Config/testthat/edition: 3
6262
Encoding: UTF-8
6363
LazyData: true
6464
Roxygen: list(markdown = TRUE)
65-
RoxygenNote: 7.2.3
65+
RoxygenNote: 7.3.1
6666
SystemRequirements: "GNU make"

‎NEWS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# textrecipes (development version)
22

3+
* Calling `?tidy.step_*()` now sends you to the documentation for `step_*()` where the outcome is documented. (#261)
4+
35
# textrecipes 1.0.6
46

57
* textfeatures has been removed from Suggests. (#255)

‎R/clean_levels.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ print.step_clean_levels <-
141141
invisible(x)
142142
}
143143

144-
#' @rdname tidy.recipe
145-
#' @param x A `step_clean_levels` object.
144+
#' @rdname step_clean_levels
145+
#' @usage NULL
146146
#' @export
147147
tidy.step_clean_levels <- function(x, ...) {
148148
if (is_trained(x)) {

‎R/clean_names.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ print.step_clean_names <-
122122
invisible(x)
123123
}
124124

125-
#' @rdname tidy.recipe
126-
#' @param x A `step_clean_names` object.
125+
#' @rdname step_clean_names
126+
#' @usage NULL
127127
#' @export
128128
tidy.step_clean_names <- function(x, ...) {
129129
if (is_trained(x)) {

‎R/dummy_hash.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ print.step_dummy_hash <-
230230
invisible(x)
231231
}
232232

233-
#' @rdname tidy.recipe
234-
#' @param x A `step_dummy_hash` object.
233+
#' @rdname step_dummy_hash
234+
#' @usage NULL
235235
#' @export
236236
tidy.step_dummy_hash <- function(x, ...) {
237237
if (is_trained(x)) {

‎R/lda.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,8 @@ print.step_lda <-
197197
invisible(x)
198198
}
199199

200-
#' @rdname tidy.recipe
201-
#' @param x A `step_lda` object.
200+
#' @rdname step_lda
201+
#' @usage NULL
202202
#' @export
203203
tidy.step_lda <- function(x, ...) {
204204
if (is_trained(x)) {

‎R/lemma.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ print.step_lemma <-
134134
invisible(x)
135135
}
136136

137-
#' @rdname tidy.recipe
138-
#' @param x A `step_lemma` object.
137+
#' @rdname step_lemma
138+
#' @usage NULL
139139
#' @export
140140
tidy.step_lemma <- function(x, ...) {
141141
if (is_trained(x)) {

‎R/ngram.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ print.step_ngram <-
156156
invisible(x)
157157
}
158158

159-
#' @rdname tidy.recipe
160-
#' @param x A `step_ngram` object.
159+
#' @rdname step_ngram
160+
#' @usage NULL
161161
#' @export
162162
tidy.step_ngram <- function(x, ...) {
163163
if (is_trained(x)) {

‎R/pos_filter.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ print.step_pos_filter <-
139139
invisible(x)
140140
}
141141

142-
#' @rdname tidy.recipe
143-
#' @param x A `step_pos_filter` object.
142+
#' @rdname step_pos_filter
143+
#' @usage NULL
144144
#' @export
145145
tidy.step_pos_filter <- function(x, ...) {
146146
if (is_trained(x)) {

‎R/sequence_onehot.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,8 @@ print.step_sequence_onehot <-
200200
invisible(x)
201201
}
202202

203-
#' @rdname tidy.recipe
204-
#' @param x A `step_sequence_onehot` object.
203+
#' @rdname step_sequence_onehot
204+
#' @usage NULL
205205
#' @export
206206
tidy.step_sequence_onehot <- function(x, ...) {
207207
if (is_trained(x)) {

‎R/stem.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,8 @@ print.step_stem <-
161161
invisible(x)
162162
}
163163

164-
#' @rdname tidy.recipe
165-
#' @param x A `step_stem` object.
164+
#' @rdname step_stem
165+
#' @usage NULL
166166
#' @export
167167
tidy.step_stem <- function(x, ...) {
168168
if (is_trained(x)) {

‎R/stopwords.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,8 @@ print.step_stopwords <-
174174
invisible(x)
175175
}
176176

177-
#' @rdname tidy.recipe
178-
#' @param x A `step_stopwords` object.
177+
#' @rdname step_stopwords
178+
#' @usage NULL
179179
#' @export
180180
tidy.step_stopwords <- function(x, ...) {
181181
if (is_trained(x)) {

‎R/text_normalization.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ print.step_text_normalization <-
147147
invisible(x)
148148
}
149149

150-
#' @rdname tidy.recipe
151-
#' @param x A `step_text_normalization` object.
150+
#' @rdname step_text_normalization
151+
#' @usage NULL
152152
#' @export
153153
tidy.step_text_normalization <- function(x, ...) {
154154
if (is_trained(x)) {

‎R/textfeature.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ print.step_textfeature <-
171171
invisible(x)
172172
}
173173

174-
#' @rdname tidy.recipe
175-
#' @param x A `step_textfeature` object.
174+
#' @rdname step_textfeatures
175+
#' @usage NULL
176176
#' @export
177177
tidy.step_textfeature <- function(x, ...) {
178178
if (is_trained(x)) {

‎R/texthash.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,8 @@ print.step_texthash <-
187187
invisible(x)
188188
}
189189

190-
#' @rdname tidy.recipe
191-
#' @param x A `step_texthash` object.
190+
#' @rdname step_texthash
191+
#' @usage NULL
192192
#' @export
193193
tidy.step_texthash <- function(x, ...) {
194194
if (is_trained(x)) {

‎R/tf.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@ print.step_tf <-
216216
invisible(x)
217217
}
218218

219-
#' @rdname tidy.recipe
220-
#' @param x A `step_tf` object.
219+
#' @rdname step_tf
220+
#' @usage NULL
221221
#' @export
222222
tidy.step_tf <- function(x, ...) {
223223
if (is_trained(x)) {

‎R/tfidf.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,8 @@ print.step_tfidf <-
208208
invisible(x)
209209
}
210210

211-
#' @rdname tidy.recipe
212-
#' @param x A `step_tfidf` object.
211+
#' @rdname step_tfidf
212+
#' @usage NULL
213213
#' @export
214214
tidy.step_tfidf <- function(x, ...) {
215215
if (is_trained(x)) {

‎R/tidy.R

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎R/tokenfilter.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,8 @@ print.step_tokenfilter <-
217217
invisible(x)
218218
}
219219

220-
#' @rdname tidy.recipe
221-
#' @param x A `step_tokenfilter` object.
220+
#' @rdname step_tokenfilter
221+
#' @usage NULL
222222
#' @export
223223
tidy.step_tokenfilter <- function(x, ...) {
224224
if (is_trained(x)) {

‎R/tokenize.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,8 +339,8 @@ print.step_tokenize <-
339339
invisible(x)
340340
}
341341

342-
#' @rdname tidy.recipe
343-
#' @param x A `step_tokenize` object.
342+
#' @rdname step_tokenize
343+
#' @usage NULL
344344
#' @export
345345
tidy.step_tokenize <- function(x, ...) {
346346
if (is_trained(x)) {

‎R/tokenize_bpe.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,8 @@ print.step_tokenize_bpe <-
192192
invisible(x)
193193
}
194194

195-
#' @rdname tidy.recipe
196-
#' @param x A `step_tokenize_bpe` object.
195+
#' @rdname step_tokenize_bpe
196+
#' @usage NULL
197197
#' @export
198198
tidy.step_tokenize_bpe <- function(x, ...) {
199199
if (is_trained(x)) {

‎R/tokenize_sentencepiece.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ print.step_tokenize_sentencepiece <-
194194
invisible(x)
195195
}
196196

197-
#' @rdname tidy.recipe
198-
#' @param x A `step_tokenize_sentencepiece` object.
197+
#' @rdname step_tokenize_sentencepiece
198+
#' @usage NULL
199199
#' @export
200200
tidy.step_tokenize_sentencepiece <- function(x, ...) {
201201
if (is_trained(x)) {

‎R/tokenize_wordpiece.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ print.step_tokenize_wordpiece <-
149149
invisible(x)
150150
}
151151

152-
#' @rdname tidy.recipe
153-
#' @param x A `step_tokenize_wordpiece` object.
152+
#' @rdname step_tokenize_wordpiece
153+
#' @usage NULL
154154
#' @export
155155
tidy.step_tokenize_wordpiece <- function(x, ...) {
156156
if (is_trained(x)) {

‎R/tokenmerge.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,8 @@ print.step_tokenmerge <-
137137
invisible(x)
138138
}
139139

140-
#' @rdname tidy.recipe
141-
#' @param x A `step_tokenmerge` object.
140+
#' @rdname step_tokenmerge
141+
#' @usage NULL
142142
#' @export
143143
tidy.step_tokenmerge <- function(x, ...) {
144144
if (is_trained(x)) {

‎R/untokenize.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ print.step_untokenize <-
130130
invisible(x)
131131
}
132132

133-
#' @rdname tidy.recipe
134-
#' @param x A `step_untokenize` object.
133+
#' @rdname step_untokenize
134+
#' @usage NULL
135135
#' @export
136136
tidy.step_untokenize <- function(x, ...) {
137137
if (is_trained(x)) {

‎R/word_embeddings.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,8 @@ print.step_word_embeddings <- function(x,
231231
invisible(x)
232232
}
233233

234-
#' @rdname tidy.recipe
235-
#' @param x A `step_word_embeddings` object.
234+
#' @rdname step_word_embeddings
235+
#' @usage NULL
236236
#' @export
237237
tidy.step_word_embeddings <- function(x, ...) {
238238
if (is_trained(x)) {

‎_pkgdown.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,3 @@ reference:
6262
- title: Data Sets
6363
contents:
6464
- emoji_samples
65-
- title: Tidy Methods
66-
contents:
67-
- tidy.recipe

‎man/step_clean_levels.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_clean_names.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_dummy_hash.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_lda.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_lemma.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_ngram.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_pos_filter.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_sequence_onehot.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_stem.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_stopwords.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/step_text_normalization.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)