File: expect_valid.Rd

package info (click to toggle)
r-cran-testextra 0.1.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 352 kB
  • sloc: sh: 13; makefile: 2
file content (27 lines) | stat: -rw-r--r-- 903 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/validity.R
\name{expect_valid}
\alias{expect_valid}
\title{Expect an S4 object is valid}
\usage{
expect_valid(object, complete = FALSE, info = NULL, label = NULL)
}
\arguments{
\item{object}{an S4 object to test for validity}

\item{complete}{logical; if \code{TRUE}, \code{validObject} is
      called recursively for each of the slots.  The default is \code{FALSE}.}

\item{info}{extra information to be included in the message (useful when
writing tests in loops).}

\item{label}{object label. When \code{NULL}, computed from deparsed object.}
}
\description{
Similar to \code{\link[=is_valid]{is_valid()}} except designed to work in the
\code{\link[testthat:test_that]{testthat::test_that()}} framework.
}
\seealso{
Other validity-tests: \code{\link{validity-tests}}
}
\concept{validity-tests}