https://github.com/cran/coin
Tip revision: d0e2eaf5ae231191c0d6278ad7b87d4e0dc855f9 authored by Torsten Hothorn on 03 November 2006, 00:00:00 UTC
version 0.5-2
version 0.5-2
Tip revision: d0e2eaf
expectation-methods.Rd
\name{expectation-methods}
\docType{methods}
\alias{expectation}
\alias{expectation-methods}
\alias{expectation,IndependenceTest-method}
\alias{expectation,IndependenceTestStatistic-method}
\alias{expectation,ScalarIndependenceTestStatistic-method}
\alias{expectation,MaxTypeIndependenceTestStatistic-method}
\alias{expectation,QuadTypeIndependenceTestStatistic-method}
\alias{covariance}
\alias{covariance-methods}
\alias{covariance,CovarianceMatrix-method}
\alias{covariance,IndependenceTest-method}
\alias{covariance,IndependenceTestStatistic-method}
\alias{covariance,ScalarIndependenceTestStatistic-method}
\alias{covariance,MaxTypeIndependenceTestStatistic-method}
\alias{covariance,QuadTypeIndependenceTestStatistic-method}
\alias{variance}
\alias{variance-methods}
\alias{variance,Variance-method}
\alias{variance,CovarianceMatrix-method}
\alias{variance,IndependenceTest-method}
\alias{variance,IndependenceTestStatistic-method}
\alias{variance,ScalarIndependenceTestStatistic-method}
\alias{variance,MaxTypeIndependenceTestStatistic-method}
\alias{variance,QuadTypeIndependenceTestStatistic-method}
\title{ Extract the Expectation and Variance / Covariance of Linear Statistics }
\description{
Extracts the conditional expectation and covariance
for linear statistics from objects inheriting from "IndependenceTest".
}
\usage{
expectation(object, ...)
covariance(object, ...)
variance(object, ...)
}
\arguments{
\item{object}{an object inheriting from class
\code{\link{IndependenceTest-class}}.}
\item{\dots}{further arguments (currently ignored).}
}
\section{Methods}{
\describe{
\item{expectation}{extracts the expectation of the linear
statistic of \code{object}.}
\item{covariance}{extracts the covariance of the linear
statistic of \code{object}.}
\item{variance}{extracts the variance of the linear
statistic of \code{object}.}
}
}
\examples{
df <- data.frame(y = gl(3, 2), x = gl(3, 2)[sample(1:6)])
### Cochran-Mantel-Haenzel Test
ct <- cmh_test(y ~ x, data = df)
### the linear statistic, i.e, the contingency table
l <- statistic(ct, type = "linear")
l
### expectation
El <- expectation(ct)
El
### covariance
Vl <- covariance(ct)
Vl
### the standardized contingency table (hard way)
(l - El) / sqrt(variance(ct))
### easy way
statistic(ct, type = "standardized")
}
\keyword{methods}