% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/partial-factor.R
\name{partial_factor}
\alias{partial_factor}
\title{Partially specify a factor}
\usage{
partial_factor(levels = character())
}
\arguments{
\item{levels}{Character vector of labels.}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}

This special class can be passed as a \code{ptype} in order to specify that the
result should be a factor that contains at least the specified levels.
}
\examples{
# Assert that `x` is a factor
vec_assert(factor("x"), partial_factor())

# Testing with `factor()` is too strict,
# because it tries to match the levels exactly
# rather than learning them from the data.
try(vec_assert(factor("x"), factor()))

# You can also enforce a minimum set of levels
try(vec_assert(factor("x"), partial_factor("y")))

vec_assert(factor(c("x", "y")), partial_factor("y"))

pf <- partial_factor(levels = c("x", "y"))
pf

vec_ptype_common(factor("v"), factor("w"), .ptype = pf)

}
\keyword{internal}