File: as.data.frame.rsplit.Rd

package info (click to toggle)
r-cran-rsample 1.2.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,932 kB
  • sloc: sh: 13; makefile: 2
file content (51 lines) | stat: -rw-r--r-- 1,393 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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rsplit.R
\name{as.data.frame.rsplit}
\alias{as.data.frame.rsplit}
\alias{analysis}
\alias{analysis.default}
\alias{analysis.rsplit}
\alias{assessment}
\alias{assessment.default}
\alias{assessment.rsplit}
\title{Convert an \code{rsplit} object to a data frame}
\usage{
\method{as.data.frame}{rsplit}(x, row.names = NULL, optional = FALSE, data = "analysis", ...)

analysis(x, ...)

\method{analysis}{default}(x, ...)

\method{analysis}{rsplit}(x, ...)

assessment(x, ...)

\method{assessment}{default}(x, ...)

\method{assessment}{rsplit}(x, ...)
}
\arguments{
\item{x}{An \code{rsplit} object.}

\item{row.names}{\code{NULL} or a character vector giving the row names for the data frame. Missing values are not allowed.}

\item{optional}{A logical: should the column names of the data be checked for legality?}

\item{data}{Either "analysis" or "assessment" to specify which data are returned.}

\item{...}{Not currently used.}
}
\description{
The analysis or assessment code can be returned as a data
frame (as dictated by the \code{data} argument) using
\code{as.data.frame.rsplit}. \code{analysis} and
\code{assessment} are shortcuts.
}
\examples{
library(dplyr)
set.seed(104)
folds <- vfold_cv(mtcars)

model_data_1 <- folds$splits[[1]] \%>\% analysis()
holdout_data_1 <- folds$splits[[1]] \%>\% assessment()
}