[Depmix-commits] r87 - trunk/man

[noreply at r-forge.r-project.org]

Author: ingmarvisser
Date: 2008-03-18 16:35:08 +0100 (Tue, 18 Mar 2008)
New Revision: 87

Added:
   trunk/man/llratio.Rd
Modified:
   trunk/man/depmix.Rd
   trunk/man/depmix.fit.Rd
   trunk/man/response.Rd
Log:
Added help for llratio

Modified: trunk/man/depmix.Rd
===================================================================
--- trunk/man/depmix.Rd	2008-03-18 10:44:18 UTC (rev 86)
+++ trunk/man/depmix.Rd	2008-03-18 15:35:08 UTC (rev 87)
@@ -1,9 +1,11 @@
 
 \name{depmix}
 
+\docType{methods}
+
 \alias{depmixS4}
 \alias{depmix}
-\alias{depmix,depmix-method}
+\alias{depmix,ANY-method}
 
 \alias{logLik}
 \alias{logLik,depmix-method}

Modified: trunk/man/depmix.fit.Rd
===================================================================
--- trunk/man/depmix.fit.Rd	2008-03-18 10:44:18 UTC (rev 86)
+++ trunk/man/depmix.fit.Rd	2008-03-18 15:35:08 UTC (rev 87)
@@ -6,9 +6,8 @@
 \alias{depmix.fit}
 \alias{fit,depmix-method}
 
-\alias{llratio}
-\alias{llratio,depmix-method}
-\alias{likelihoodratio}
+\alias{show,depmix.fitted-method}
+\alias{summary,depmix.fitted-method}
 
 \title{Fit depmix models}
 
@@ -19,14 +18,14 @@
 	
 	\S4method{fit}{depmix}(object, w=NULL, fixed=NULL, equal=NULL, conrows=NULL,
 		conrows.upper=0, conrows.lower=0, method=NULL,...)
-		
-	llratio(basemodel,constrainedmodel,...)
 	
+	\S4method{summary}{depmix.fitted}(object)
+	
+	
 }
 
 \arguments{
 	\item{object}{An object of class \code{depmix}.}
-	\item{basemodel, constrainedmodel}{Objects of class \code{depmix.fitted}.}
 	\item{w}{Weights??? What's this argument doing here? It's not being
 		used.}
 	\item{fixed}{Vector of mode logical indicating which parameters should 

Added: trunk/man/llratio.Rd
===================================================================
--- trunk/man/llratio.Rd	                        (rev 0)
+++ trunk/man/llratio.Rd	2008-03-18 15:35:08 UTC (rev 87)
@@ -0,0 +1,46 @@
+\name{llratio}
+
+\docType{method}
+
+\alias{llratio}
+\alias{llratio,depmix.fitted-method}
+\alias{likelihoodratio}
+
+\alias{show,llratio-method}
+
+\title{Log likelihood ratio test on two fitted models}
+
+\description{Performs a log likelihood ratio test on two fitted
+\code{depmix} models.}
+
+\usage{
+	
+	llratio(basemodel,constrainedmodel,...)
+	
+}
+
+\arguments{ 
+	
+	\item{basemodel}{Fitted depmix model.}
+	
+	\item{constrainedmodel}{Fitted depmix model.}
+	
+	\item{...}{Not currently used.}
+	
+}
+
+\value{
+	\code{llratio} returns an object of class \code{llratio} which has slots: 
+	
+	\item{value}: Minus twice the loglikelihood difference. 
+	
+	\item{df}: The degrees of freedom, ie the difference in number of freely
+	estimated paraemters between the models. 
+	
+	The print method shows the value, 
+	
+}
+
+\author{Ingmar Visser}
+
+\keyword{methods}
\ No newline at end of file

Modified: trunk/man/response.Rd
===================================================================
--- trunk/man/response.Rd	2008-03-18 10:44:18 UTC (rev 86)
+++ trunk/man/response.Rd	2008-03-18 15:35:08 UTC (rev 87)
@@ -6,9 +6,11 @@
 \alias{transInit}
 \alias{GLMresponse}
 
-\alias{transInit,formula,GLMresponse-method}
-\alias{GLMresponse,formula,GLMresponse-method}
+\alias{transInit,formula-method}
+\alias{GLMresponse,formula-method}
 
+\alias{show,GLMresponse-method}
+
 \title{Methods for creating depmix response models}
 
 \description{Create \code{\link[depmix]{response}} models.}
@@ -58,6 +60,7 @@
 }
 
 \value{
+	
 	\code{GLMresponse} and \code{transInit} return objects of class
 	\code{GLMresponse} and \code{transInit} respectively; both classes
 	extend the \code{\link[depmix]{response-class}}.