From 852c0d1df8a8243086081482bcebf0f2ce032ba7 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Wed, 18 Dec 2024 11:22:20 -0800 Subject: [PATCH] document all functions --- R/model-partykit.R | 3 +++ R/model-xgboost.R | 3 +++ man/dot-extract_partykit_classprob.Rd | 12 ++++++++++++ man/dot-extract_xgb_trees.Rd | 12 ++++++++++++ man/tidypredict-package.Rd | 3 ++- 5 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 man/dot-extract_partykit_classprob.Rd create mode 100644 man/dot-extract_xgb_trees.Rd diff --git a/R/model-partykit.R b/R/model-partykit.R index 6a65e0d..99f76ec 100644 --- a/R/model-partykit.R +++ b/R/model-partykit.R @@ -103,6 +103,9 @@ tidypredict_fit.party <- function(model) { } # For {orbital} +#' Extract classprob trees for partykit models +#' +#' For use in orbital package. #' @keywords internal #' @export .extract_partykit_classprob <- function(model) { diff --git a/R/model-xgboost.R b/R/model-xgboost.R index bf9ca0f..74497db 100644 --- a/R/model-xgboost.R +++ b/R/model-xgboost.R @@ -185,6 +185,9 @@ tidypredict_fit.xgb.Booster <- function(model) { } # For {orbital} +#' Extract processed xgboost trees +#' +#' For use in orbital package. #' @keywords internal #' @export .extract_xgb_trees <- function(model) { diff --git a/man/dot-extract_partykit_classprob.Rd b/man/dot-extract_partykit_classprob.Rd new file mode 100644 index 0000000..364bdad --- /dev/null +++ b/man/dot-extract_partykit_classprob.Rd @@ -0,0 +1,12 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/model-partykit.R +\name{.extract_partykit_classprob} +\alias{.extract_partykit_classprob} +\title{Extract classprob trees for partykit models} +\usage{ +.extract_partykit_classprob(model) +} +\description{ +For use in orbital package. +} +\keyword{internal} diff --git a/man/dot-extract_xgb_trees.Rd b/man/dot-extract_xgb_trees.Rd new file mode 100644 index 0000000..39a3365 --- /dev/null +++ b/man/dot-extract_xgb_trees.Rd @@ -0,0 +1,12 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/model-xgboost.R +\name{.extract_xgb_trees} +\alias{.extract_xgb_trees} +\title{Extract processed xgboost trees} +\usage{ +.extract_xgb_trees(model) +} +\description{ +For use in orbital package. +} +\keyword{internal} diff --git a/man/tidypredict-package.Rd b/man/tidypredict-package.Rd index 630605c..6f5723a 100644 --- a/man/tidypredict-package.Rd +++ b/man/tidypredict-package.Rd @@ -20,10 +20,11 @@ Useful links: } \author{ -\strong{Maintainer}: Edgar Ruiz \email{edgar@posit.co} +\strong{Maintainer}: Emil Hvitfeldt \email{emil.hvitfeldt@posit.co} Authors: \itemize{ + \item Edgar Ruiz \email{edgar@posit.co} \item Max Kuhn \email{max@posit.co} }