Skip to content

Refresh pkgdown #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ tests/testthat/logs/
derby.log
logs/*
revdep/*
docs*
1 change: 1 addition & 0 deletions R/augment.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#' @param x A `model_fit` object produced by [fit()] or [fit_xy()].
#' @param new_data A data frame or matrix.
#' @param ... Not currently used.
#' @rdname augment
#' @export
#' @examples
#' car_trn <- mtcars[11:32,]
Expand Down
2 changes: 1 addition & 1 deletion R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#' @aliases model_db
#' @docType data
#' @return \item{model_db}{a data frame}
#' @keywords datasets
#' @keywords datasets internal
#' @examples
#' data(model_db)
NULL
Expand Down
3 changes: 2 additions & 1 deletion R/nullmodel.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
#'
#' `predict.nullmodel()` returns either a factor or numeric vector
#' depending on the class of \code{y}. All predictions are always the same.
#' @keywords models
#' @keywords models internal
#' @examples
#'
#' outcome <- factor(sample(letters[1:2],
Expand Down Expand Up @@ -181,6 +181,7 @@ null_model <-
#' @param ... Not used.
#' @return A tibble with column `value`.
#' @export
#' @keywords internal
#' @examples
#'
#' nullmodel(mtcars[,-1], mtcars$mpg) %>% tidy()
Expand Down
1 change: 1 addition & 0 deletions R/tidy_glmnet.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#' @return A tibble with columns `term`, `estimate`, and `penalty`. When a
#' multinomial mode is used, an additional `class` column is included.
#' @importFrom stats coef
#' @keywords internal
#' @export
tidy._elnet <- function(x, penalty = NULL, ...) {
tidy_glmnet(x, penalty)
Expand Down
6 changes: 4 additions & 2 deletions R/varying.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
#'
#' [varying()] is used when a parameter will be specified at a later date.
#' @export
#' @keywords internal
varying <- function() {
quote(varying())
}
Expand Down Expand Up @@ -58,6 +59,7 @@ generics::varying_args
#' varying_args()
#'
#' @importFrom purrr map map_lgl
#' @rdname varying_args
#' @export
varying_args.model_spec <- function(object, full = TRUE, ...) {

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

#' @importFrom purrr map2_dfr map_chr
#' @export
#' @rdname varying_args.model_spec
#' @rdname varying_args
varying_args.recipe <- function(object, full = TRUE, ...) {

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

#' @importFrom purrr map map_lgl
#' @export
#' @rdname varying_args.model_spec
#' @rdname varying_args
varying_args.step <- function(object, full = TRUE, ...) {

# Unique step id
Expand Down
14 changes: 12 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,30 +37,40 @@ reference:
- title: Infrastructure
contents:
- add_rowindex
- augment.model_fit
- descriptors
- fit.model_spec
- fit_xy
- fit_control
- glance.model_fit
- model_fit
- model_spec
- predict.model_fit
- multi_predict
- parsnip_addin
- predict.model_fit
- reexports
- repair_call
- set_args
- set_engine
- set_mode
- show_engines
- tidy.model_fit
- translate
- augment.model.fit
- varying_args.model_spec

- title: Developer Tools
contents:
- contr_one_hot
- set_new_model
- starts_with("set_model_")
- set_dependency
- set_fit
- set_pred
- show_model_info
- starts_with("get_")
- maybe_matrix
- min_cols
- req_pkgs



Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions man/model_db.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/nullmodel.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/tidy._elnet.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/tidy.nullmodel.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/varying.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

File renamed without changes.