% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/scaffold_tests.R
\name{scaffold_tests}
\alias{scaffold_tests}
\title{Interactive Test-Suite Architect}
\usage{
scaffold_tests()
}
\value{
Invisibly returns a named list with components: \code{status} ("done",
"cancelled", or "error"), \code{function_name}, \code{test_file},
and \code{output_type}.
}
\description{
Scaffolds CRAN-compliant `testthat` boilerplate for a specific function 
by interactively prompting the user about expected behaviors, output 
types, and edge cases.
}
\details{
The function automates the creation of a test file in the `tests/testthat/` 
directory:
\enumerate{
  \item Verifies that the `tests/testthat` directory exists (suggesting 
      `usethis::use_testthat()` if it does not).
  \item Prompts for the name of the function to be tested and creates a 
      corresponding `test-functionname.R` file.
  \item Interactively determines the expected output type (e.g., data frame, 
      list, numeric) to generate appropriate `expect_*` calls.
  \item Asks whether to include tests for output dimensions or error 
      handling for invalid inputs.
  \item Writes a structured boilerplate file containing `test_that` blocks 
      with TODO comments for the user to fill in mock data.
}
}
\section{Warning}{

This function modifies files on disk or the global environment. Please ensure you have a backup or are using version control (e.g., Git) before execution.
}

\examples{
if (interactive()) {
  scaffold_tests()
}
}
