Skip to content

Commit 2d41291

Browse files
authored
Merge pull request #427 from tidymodels/pkgdown-refresh
Refresh pkgdown
2 parents 9cc0dc7 + 580f9b5 commit 2d41291

14 files changed

+27
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ tests/testthat/logs/
88
derby.log
99
logs/*
1010
revdep/*
11+
docs*

R/augment.R

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
#' @param x A `model_fit` object produced by [fit()] or [fit_xy()].
1212
#' @param new_data A data frame or matrix.
1313
#' @param ... Not currently used.
14+
#' @rdname augment
1415
#' @export
1516
#' @examples
1617
#' car_trn <- mtcars[11:32,]

R/data.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
#' @aliases model_db
88
#' @docType data
99
#' @return \item{model_db}{a data frame}
10-
#' @keywords datasets
10+
#' @keywords datasets internal
1111
#' @examples
1212
#' data(model_db)
1313
NULL

R/nullmodel.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
#'
3232
#' `predict.nullmodel()` returns either a factor or numeric vector
3333
#' depending on the class of \code{y}. All predictions are always the same.
34-
#' @keywords models
34+
#' @keywords models internal
3535
#' @examples
3636
#'
3737
#' outcome <- factor(sample(letters[1:2],
@@ -181,6 +181,7 @@ null_model <-
181181
#' @param ... Not used.
182182
#' @return A tibble with column `value`.
183183
#' @export
184+
#' @keywords internal
184185
#' @examples
185186
#'
186187
#' nullmodel(mtcars[,-1], mtcars$mpg) %>% tidy()

R/tidy_glmnet.R

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
#' @return A tibble with columns `term`, `estimate`, and `penalty`. When a
1010
#' multinomial mode is used, an additional `class` column is included.
1111
#' @importFrom stats coef
12+
#' @keywords internal
1213
#' @export
1314
tidy._elnet <- function(x, penalty = NULL, ...) {
1415
tidy_glmnet(x, penalty)

R/varying.R

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
#'
33
#' [varying()] is used when a parameter will be specified at a later date.
44
#' @export
5+
#' @keywords internal
56
varying <- function() {
67
quote(varying())
78
}
@@ -58,6 +59,7 @@ generics::varying_args
5859
#' varying_args()
5960
#'
6061
#' @importFrom purrr map map_lgl
62+
#' @rdname varying_args
6163
#' @export
6264
varying_args.model_spec <- function(object, full = TRUE, ...) {
6365

@@ -94,7 +96,7 @@ varying_args.model_spec <- function(object, full = TRUE, ...) {
9496

9597
#' @importFrom purrr map2_dfr map_chr
9698
#' @export
97-
#' @rdname varying_args.model_spec
99+
#' @rdname varying_args
98100
varying_args.recipe <- function(object, full = TRUE, ...) {
99101

100102
steps <- object$steps
@@ -108,7 +110,7 @@ varying_args.recipe <- function(object, full = TRUE, ...) {
108110

109111
#' @importFrom purrr map map_lgl
110112
#' @export
111-
#' @rdname varying_args.model_spec
113+
#' @rdname varying_args
112114
varying_args.step <- function(object, full = TRUE, ...) {
113115

114116
# Unique step id

_pkgdown.yml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,40 @@ reference:
3737
- title: Infrastructure
3838
contents:
3939
- add_rowindex
40+
- augment.model_fit
4041
- descriptors
4142
- fit.model_spec
4243
- fit_xy
4344
- fit_control
45+
- glance.model_fit
4446
- model_fit
4547
- model_spec
46-
- predict.model_fit
4748
- multi_predict
49+
- parsnip_addin
50+
- predict.model_fit
51+
- reexports
52+
- repair_call
4853
- set_args
4954
- set_engine
5055
- set_mode
56+
- show_engines
5157
- tidy.model_fit
5258
- translate
53-
- augment.model.fit
59+
- varying_args.model_spec
5460

5561
- title: Developer Tools
5662
contents:
63+
- contr_one_hot
5764
- set_new_model
5865
- starts_with("set_model_")
5966
- set_dependency
6067
- set_fit
6168
- set_pred
6269
- show_model_info
6370
- starts_with("get_")
71+
- maybe_matrix
72+
- min_cols
73+
- req_pkgs
6474

6575

6676

File renamed without changes.

man/model_db.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/nullmodel.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/tidy._elnet.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/tidy.nullmodel.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/varying.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.
File renamed without changes.

0 commit comments

Comments
 (0)