export the format_*() functions (#740)

Author: topepo

NAMESPACE

@@ -198,6 +198,13 @@ export(fit.model_spec)
 export(fit_control)
 export(fit_xy)
 export(fit_xy.model_spec)
+export(format_class)
+export(format_classprobs)
+export(format_hazard)
+export(format_linear_pred)
+export(format_num)
+export(format_survival)
+export(format_time)
 export(gen_additive_mod)
 export(get_dependency)
 export(get_encoding)

R/predict.R

@@ -208,6 +208,17 @@ check_pred_type <- function(object, type, ...) {
   type
 }
 
+#' Internal functions that format predictions
+#'
+#' These are used to ensure that we have appropriate column names inside of
+#' tibbles.
+#'
+#' @param x A data frame or vector (depending on the context and function).
+#' @return A tibble
+#' @keywords internal
+#' @name format-internals
+#' @export
+
 format_num <- function(x) {
   if (inherits(x, "tbl_spark"))
     return(x)
@@ -224,13 +235,17 @@ format_num <- function(x) {
   x
 }
 
+#' @rdname format-internals
+#' @export
 format_class <- function(x) {
   if (inherits(x, "tbl_spark"))
     return(x)
 
   tibble(.pred_class = unname(x))
 }
 
+#' @rdname format-internals
+#' @export
 format_classprobs <- function(x) {
   if (!any(grepl("^\\.pred_", names(x)))) {
     names(x) <- paste0(".pred_", names(x))
@@ -240,6 +255,8 @@ format_classprobs <- function(x) {
   x
 }
 
+#' @rdname format-internals
+#' @export
 format_time <- function(x) {
   if (isTRUE(ncol(x) > 1) | is.data.frame(x)) {
     x <- as_tibble(x, .name_repair = "minimal")
@@ -253,6 +270,8 @@ format_time <- function(x) {
   x
 }
 
+#' @rdname format-internals
+#' @export
 format_survival <- function(x) {
   if (isTRUE(ncol(x) > 1) | is.data.frame(x)) {
     x <- as_tibble(x, .name_repair = "minimal")
@@ -264,6 +283,8 @@ format_survival <- function(x) {
   x
 }
 
+#' @rdname format-internals
+#' @export
 format_linear_pred <- function(x) {
   if (inherits(x, "tbl_spark"))
     return(x)
@@ -278,6 +299,8 @@ format_linear_pred <- function(x) {
   x
 }
 
+#' @rdname format-internals
+#' @export
 format_hazard <- function(x) {
   if (isTRUE(ncol(x) > 1) | is.data.frame(x)) {
     x <- as_tibble(x, .name_repair = "minimal")