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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
|
\name{fHTEST-class}
\Rdversion{1.1}
\docType{class}
\alias{fHTEST-class}
\alias{fHTEST}
\alias{show,fHTEST-method}
\title{Class \code{"fHTEST"}}
\description{
An S4 class representing the outcome of a statistical test.
}
\section{Objects from the Class}{
% Objects can be created by calls of the form \code{new("fHTEST", ...)}.
Objects from this class are created by some statistical test functions.
%% ~~ describe objects here ~~
}
\section{Slots}{
\describe{
\item{\code{call}:}{
the function call.
}
\item{\code{data}:}{
the data as specified by the input argument(s).
}
\item{\code{test}:}{
a list whose elements contain the results from the statistical
test. The information provided is similar to a list object of
class \code{"htest"}.
}
\item{\code{title}:}{
a character string with the name of the test. This can be
overwritten specifying a user defined input argument.
}
\item{\code{description}:}{
a character string with an optional user defined description. By
default just the current date when the test was applied will be
returned.
}
}
Slot \code{@test} is an object of class \code{"list"} containing at
least the following elements:
\describe{
\item{statistic}{
the value(s) of the test statistic.
}
\item{p.value}{
the p-value(s) of the test.
}
\item{parameters}{
a numeric value or vector of parameters.
}
\item{estimate}{
a numeric value or vector of sample estimates.
}
\item{conf.int}{
a numeric two row vector or matrix of 95\% confidence levels.
}
\item{method}{
a character string indicating what type of test was performed.
}
\item{data.name}{
a character string giving the name(s) of the data.
}
}
}
\section{Methods}{
\describe{
\item{show}{\code{signature(object = "fHTEST")}: ... }
}
}
\seealso{
for functions returning objects from class \code{"fHTEST"}, see
\code{\link{scaleTest}},
\code{\link{correlationTest}},
\code{\link{ks2Test}},
\code{\link{locationTest}},
\code{\link{NormalityTests}},
\code{\link{varianceTest}}
\code{\link{scaleTest}}
}
\examples{
showClass("fHTEST")
}
\keyword{classes}
\keyword{htest}
|