<!doctype s-function-doc system "s-function-doc.dtd" [
<!entity % S-OLD "INCLUDE">
]
>
<s-function-doc>
<s-topics>
   <s-topic>summary.lmRobBI</s-topic>
</s-topics>
<s-title>
Compute a Summary of an lmRobBI Object
</s-title>
<s-description>
Computes a summary of an of object of class <TT>"lmRobBI"</TT>.
</s-description>
<s-usage>
<s-old-style-usage>
summary.lmRobBI(object, correlation=T) 
</s-old-style-usage>
</s-usage>
<s-args-required>
</s-args-required>
<s-args-optional>
~move the above line to just above the first optional argument 
<s-arg name="object">
~Describe object here 
</s-arg>
<s-arg name="correlation">
~Describe correlation here 
</s-arg>
</s-args-optional>
<s-value>
~Describe the value returned 
</s-value>
<s-side-effects>
~describe any side effects if they exist 
</s-side-effects>
<s-details>
~explain details here. 
</s-details>
<s-section name=" REFERENCES">

~put references here, make other sections like NOTE and WARNING with .SH 
</s-section>
<s-see>
~put functions to SEE ALSO here  </s-see>
<s-examples>
<s-example type = text>
# The function is currently defined as 
function(object, correlation = T) 
{ 
	wt <- object$M.weights 
	wt1 <- object$weights 
	if(!is.null(wt1)) 
		wt <- wt * wt1 
	coef <- coefficients(object) 
	cnames <- labels(coef) 
	ctotal <- object$coef 
	ptotal <- length(ctotal) 
	resid <- object$residuals 
	fv <- object$fitted 
	n <- length(resid) 
	p <- object$rank 
	if(is.null(p)) 
		p <- sum(!is.na(ctotal)) 
	if(any(na <- is.na(coef))) { 
		coef <- coef[!na] 
		p <- length(coef) 
	} 
	rdf <- n - p 
	if(!is.null(wt1)) { 
		wt1 <- wt1^0.5 
		resid <- resid * wt1 
		fv <- fv * wt1 
		excl <- wt1 == 0 
		if(any(excl)) { 
			warning(paste(sum(excl),  
				"rows with zero weights not counted")) 
			resid <- resid[!excl] 
			fv <- fv[!excl] 
			wt1 <- wt1[!excl] 
			if(is.null(object$df.residual)) 
				rdf <- rdf - sum(excl) 
			wt <- wt * wt1 
		} 
	} 
	stddev <- object$scale 
	cov <- object$cov 
	var <- diag(cov) 
	if(p < ptotal) 
		R <- R[1:p, 1:p, drop = F] 
	if(correlation) { 
		correl <- cov/sqrt(var) 
		correl <- t(correl)/sqrt(var) 
	} 
	else correl <- NULL 
	coef <- array(coef, c(p, 4)) 
	dimnames(coef) <- list(cnames, c("Value", "Std. Error", "t value",  
		"Pr(>|t|)")) 
	coef[, 2] <- sqrt(var) 
	coef[, 3] <- coef[, 1]/coef[, 2] 
	coef[, 4] <- if(rdf > 0) 2 * (1 - pt(abs(coef[, 3]), rdf)) else NA 
	yy <- fv + resid 
	int <- attr(object$terms, "intercept") 
	object <- object[c("call", "terms", "iter.coef", "iter.weight",  
		"O.weights", "na.action")] 
	object$residuals <- resid 
	object$coefficients <- coef 
	object$sigma <- stddev 
	object$df <- c(p, rdf, ptotal) 
	object$cov.unscaled <- cov/stddev^2 
	object$correlation <- correl 
	class(object) <- c("summary.lmRobBI", "summary.lm") 
	object 
} 
</s-example>
</s-examples>
<s-keywords>
<s-keyword>librobust</s-keyword>
</s-keywords>
<s-docclass>
function
</s-docclass>
</s-function-doc>
