File: extract_ptype.Rd

package info (click to toggle)
r-cran-hardhat 1.2.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,656 kB
  • sloc: sh: 13; makefile: 2
file content (30 lines) | stat: -rw-r--r-- 823 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ptype.R
\name{extract_ptype}
\alias{extract_ptype}
\title{Extract a prototype}
\usage{
extract_ptype(data)
}
\arguments{
\item{data}{A data frame or matrix.}
}
\value{
A 0 row slice of \code{data} after converting it to a tibble.
}
\description{
\code{extract_ptype()} extracts a tibble with 0 rows from \code{data}. This contains
all of the required information about column names, classes, and factor
levels that are required to check the structure of new data at prediction
time.
}
\details{
\code{extract_ptype()} is useful when creating a new preprocessing \code{blueprint}. It
extracts the required information that will be used by the validation checks
at prediction time.
}
\examples{

hardhat:::extract_ptype(iris)
}
\keyword{internal}