testModel.Rd

% File man/testModel.Rd
% Part of the DEVISE package, https://github.com/cwendorf/DEVISE

\name{testModel}
\alias{testModel}
\alias{testRegressionModel}
\title{Test Model}
\description{Provides a statistical significance test for a regression model.}

\usage{
\method{testModel}{default}(frame, y=NULL, main=NULL, digits=3)

\method{testModel}{wss}(DescStats, CorrStats, y=NULL, main=NULL, digits=3)
}

\arguments{
\item{frame}{a set of (non-empty) numeric vectors of data values}
\item{DescStats}{a matrix/frame of descriptive/summary statistics}
\item{CorrStats}{a matrix/frame of correlations for the data set}
\item{y}{the name of the criterion}
\item{main}{a custom title for the table}
\item{digits}{the specified number of decimal places}
}

\value{
The returned list contains one frame with the following components:    
\item{F}{the F value for the regression model}
\item{df1}{the degrees of freedom for the regression model}
\item{df2}{the degrees of freedom for the error term}
\item{p}{the p value for the regression model}
}