mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-14 09:28:02 -05:00
40 lines
1.7 KiB
R
40 lines
1.7 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/test.R
|
|
\name{runTests}
|
|
\alias{runTests}
|
|
\title{Runs the tests associated with this Shiny app}
|
|
\usage{
|
|
runTests(appDir = ".", filter = NULL, assert = TRUE, envir = globalenv())
|
|
}
|
|
\arguments{
|
|
\item{appDir}{The base directory for the application.}
|
|
|
|
\item{filter}{If not \code{NULL}, only tests with file names matching this regular
|
|
expression will be executed. Matching is performed on the file name
|
|
including the extension.}
|
|
|
|
\item{assert}{Logical value which determines if an error should be thrown if any error is captured.}
|
|
|
|
\item{envir}{Parent testing environment in which to base the individual testing environments.}
|
|
}
|
|
\value{
|
|
A data frame classed with the supplemental class \code{"shiny_runtests"}.
|
|
The data frame has the following columns:\tabular{lll}{
|
|
\strong{Name} \tab \strong{Type} \tab \strong{Meaning} \cr
|
|
\code{file} \tab \code{character(1)} \tab File name of the runner script in \verb{tests/} that was sourced. \cr
|
|
\code{pass} \tab \code{logical(1)} \tab Whether or not the runner script signaled an error when sourced. \cr
|
|
\code{result} \tab any or \code{NA} \tab The return value of the runner \cr
|
|
}
|
|
}
|
|
\description{
|
|
Sources the \code{.R} files in the top-level of \verb{tests/} much like \verb{R CMD check}.
|
|
These files are typically simple runners for tests nested in other
|
|
directories under \verb{tests/}.
|
|
}
|
|
\details{
|
|
Historically, \href{https://rstudio.github.io/shinytest/}{shinytest}
|
|
recommended placing tests at the top-level of the \verb{tests/} directory.
|
|
This older folder structure is not supported by runTests.
|
|
Please see \code{\link[=shinyAppTemplate]{shinyAppTemplate()}} for more details.
|
|
}
|