[Splm-commits] r170 - pkg/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sat Jun 29 17:34:56 CEST 2013
Author: the_sculler
Date: 2013-06-29 17:34:56 +0200 (Sat, 29 Jun 2013)
New Revision: 170
Modified:
pkg/man/RiceFarms.Rd
pkg/man/bsjktest.Rd
pkg/man/bsktest.Rd
pkg/man/effects.splm.Rd
pkg/man/listw2dgCMatrix.Rd
pkg/man/print.splm.Rd
pkg/man/spgm.Rd
pkg/man/sphtest.Rd
pkg/man/spml.Rd
pkg/man/spreml.Rd
pkg/man/summary.splm.Rd
pkg/man/usaww.Rd
pkg/man/vcov.splm.Rd
pkg/man/write.effects.splm.Rd
Log:
fixed man files
Modified: pkg/man/RiceFarms.Rd
===================================================================
--- pkg/man/RiceFarms.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/RiceFarms.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -34,7 +34,7 @@
\item{goutput}{gross output of rice in kg}
\item{noutput}{net output, gross output minus harvesting cost (paid in terms of rice)}
\item{price}{price of rough rice in Rupiah per kg}
- \item{region}{one of \code{'wargabinangun'}, \code{'langan'}, \code{'gunungwangi'}, \code{'malausma'}, \code{'sukaambit'}, \code{'ciwangi'}}
+ \item{region}{one of six regions}
}
}
\source{
Modified: pkg/man/bsjktest.Rd
===================================================================
--- pkg/man/bsjktest.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/bsjktest.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -14,10 +14,9 @@
}
\arguments{
\item{x}{an object of class \code{formula}}
- \item{data}{an object of class \code{\link{data.frame}} or \code{pdata.frame}. An optional data frame containing the variables
- in the model. When the obect is a \code{\link{data.frame}}, the first two columns may contain the indexes. See \code{index}}
- \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{\link{data.frame}}}
-\item{listw}{either a \code{matrix} or an object of class \code{listw} created for example by \code{nb2listw}, representing the spatial structure}
+ \item{data}{a \code{data.frame} or \code{pdata.frame} containing the variables in the model}
+ \item{index}{either NULL (default) or a character vector to identify the indexes among the columns of the \code{data.frame}}
+\item{listw}{either a \code{matrix} or a \code{listw} representing the spatial structure}
\item{test}{one of \code{c("C.1","C.2","C.3","J")}, the
test to be performed. "C.3" is not implemented yet.}
\item{...}{additional arguments to be passed}
@@ -30,7 +29,7 @@
Testing panel data regression models with spatial and serial error correlation.
\emph{Journal of Econometrics}, \bold{140}, 5-51.}
\author{Giovanni Millo}
-\seealso{\code{\link{bsktest}}}
+\seealso{\code{bsktest}}
\examples{
data(Produc, package="Ecdat")
Modified: pkg/man/bsktest.Rd
===================================================================
--- pkg/man/bsktest.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/bsktest.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -10,14 +10,15 @@
\usage{
bsktest(x,...)
\method{bsktest}{formula}(x, data, index=NULL, listw,
-test=c("LMH","LM1","LM2","CLMlambda","CLMmu"), standardize=TRUE, ...)
+test=c("LMH","LM1","LM2","CLMlambda","CLMmu"),
+standardize=TRUE, ...)
}
\arguments{
-\item{x}{an object of class \code{formula}}
- \item{data}{an object of class \code{\link{data.frame}} or \code{pdata.frame}. An optional data frame containing the variables
- in the model. When the obect is a \code{\link{data.frame}}, the first two columns may contain the indexes. See \code{index}}
- \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{\link{data.frame}}}
-\item{listw}{an object of class \code{listw} created for example by \code{nb2listw} }
+\item{x}{a \code{formula}}
+ \item{data}{a \code{data.frame} or \code{pdata.frame} containing the variables
+ in the model}
+ \item{index}{either NULL (default) or a character vector to identify the indexes among the columns of the \code{data.frame}}
+\item{listw}{a \code{listw} representing the spatial structure}
\item{test}{one of \code{c("LMH","LM1","LM2","CLMlambda","CLMmu")}, the
test to be performed}
\item{standardize}{whether to standardize the test statistic or not (applies only to LM1 and LM2)}
@@ -36,7 +37,7 @@
\emph{Journal of Statistical Software}, \bold{47(1)}, 1--38.
URL http://www.jstatsoft.org/v47/i01/.}
\author{Gianfranco Piras}
-\seealso{\code{\link{sphtest}}}
+\seealso{\code{sphtest}}
\examples{
data(Produc, package="Ecdat")
Modified: pkg/man/effects.splm.Rd
===================================================================
--- pkg/man/effects.splm.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/effects.splm.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -46,10 +46,10 @@
}
-\author{ Gianfranco Piras \email{gpiras at mac.com}}
+\author{Gianfranco Piras}
\seealso{
-\code{\link{spml}} \code{summary.effects.splm}
+\code{spml} \code{summary.effects.splm}
}
\examples{
data(Produc, package = "Ecdat")
Modified: pkg/man/listw2dgCMatrix.Rd
===================================================================
--- pkg/man/listw2dgCMatrix.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/listw2dgCMatrix.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -21,7 +21,7 @@
Matrix class object: a sparse Matrix}
-\author{ Gianfranco Piras \email{gpiras at mac.com}}
+\author{Gianfranco Piras}
\examples{
library(spdep)
Modified: pkg/man/print.splm.Rd
===================================================================
--- pkg/man/print.splm.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/print.splm.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -12,7 +12,7 @@
\arguments{
\item{x}{an object of class \code{splm}}
-\item{digits}{minimal number of significant digits, see \code{\link{print.default}}}
+\item{digits}{minimal number of significant digits, see \code{print.default}}
\item{...}{additional arguments to be passed}
}
@@ -28,7 +28,7 @@
}
\seealso{
- \code{\link{spml}}, \code{\link{spgm}}
+ \code{spml}, \code{spgm}
}
\author{Giovanni Millo, Gianfranco Piras}
Modified: pkg/man/spgm.Rd
===================================================================
--- pkg/man/spgm.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/spgm.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -21,18 +21,19 @@
\usage{
spgm(formula, data=list(), index=NULL, listw,
- model=c("within","random"), lag=FALSE, spatial.error=FALSE,
- moments = c("initial", "weights", "fullweights"), endog = NULL,
- instruments= NULL, verbose = FALSE,
- method = c("w2sls", "b2sls", "g2sls", "ec2sls"), control = list())
+ model=c("within","random"), lag=FALSE, spatial.error=FALSE,
+ moments = c("initial", "weights", "fullweights"), endog = NULL,
+ instruments= NULL, verbose = FALSE,
+ method = c("w2sls", "b2sls", "g2sls", "ec2sls"),
+ control = list())
}
\arguments{
\item{formula}{a description of the model to be fit. The details of model specification are given
for \code{lm} }
- \item{data}{an object of class \code{\link{data.frame}} or \code{pdata.frame}. An optional data frame containing the variables
- in the model. When the obect is a \code{\link{data.frame}}, the first two columns may contain the indexes. See \code{index}}
- \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{\link{data.frame}}}
+ \item{data}{an object of class \code{data.frame} or \code{pdata.frame}. An optional data frame containing the variables
+ in the model. When the obect is a \code{data.frame}, the first two columns may contain the indexes. See \code{index}}
+ \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{data.frame}}
\item{listw}{an object of class \code{listw} created for example by \code{nb2listw}.
If a \code{matrix} is given as input the function will transform it using \code{mat2listw}}
\item{model}{One of \code{"within"} or \code{"random"}. The assumption
@@ -71,7 +72,7 @@
covariance matrix of the sample moments calculated under the assumption of
normally distributed innovations. The calculation of the trace terms in the expression
of the variance covariance matrix of the sample moments
-uses codes from the \code{\link{Matrix}} package.
+uses codes from the \code{Matrix} package.
When \code{moments} is\code{"weights"}, the third set of GM estimator is used. This is motivated by computational
issues. The procedure is analogous to the second one but uses a simplified expression for the
variance covariance matrix of the sample moments.
@@ -132,7 +133,7 @@
URL http://www.jstatsoft.org/v47/i01/.
}
-\author{ Gianfranco Piras \email{gpiras at mac.com}}
+\author{Gianfranco Piras}
\examples{
@@ -143,4 +144,4 @@
summary(GM)
}
-\keyword{spatial}
\ No newline at end of file
+\keyword{spatial}
Modified: pkg/man/sphtest.Rd
===================================================================
--- pkg/man/sphtest.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/sphtest.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -18,9 +18,9 @@
\arguments{
\item{x}{an object of class \code{formula} or \code{splm} }
\item{x2}{an object of class \code{splm} }
- \item{data}{an object of class \code{\link{data.frame}} or \code{pdata.frame}. An optional data frame containing the variables
- in the model. When the obect is a \code{\link{data.frame}}, the first two columns may contain the indexes. See \code{index}}
-\item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{\link{data.frame}}}
+ \item{data}{an object of class \code{data.frame} or \code{pdata.frame}. An optional data frame containing the variables
+ in the model. When the obect is a \code{data.frame}, the first two columns may contain the indexes. See \code{index}}
+\item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{data.frame}}
\item{listw}{an object of class \code{listw} created for example by \code{nb2listw} }
\item{spatial.model}{one of \code{c("lag","error","sarar")}, the model to be estimated (only lag, only error, both lag and error dependence)}
\item{method}{one of \code{c("ML","GM")}}
@@ -40,7 +40,7 @@
\author{Gianfranco Piras}
-\seealso{\code{\link{spgm}}}
+\seealso{\code{spgm}}
\examples{
data(Produc, package="Ecdat")
@@ -56,4 +56,4 @@
test2<-sphtest(mod1, mod2)
test2
}
-\keyword{htest}
\ No newline at end of file
+\keyword{htest}
Modified: pkg/man/spml.Rd
===================================================================
--- pkg/man/spml.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/spml.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -14,9 +14,9 @@
\arguments{
\item{formula}{a symbolic description of the model to be estimated}
- \item{data}{an object of class \code{\link{data.frame}} or \code{pdata.frame}. A data frame containing the variables
- in the model. When the object is a \code{\link{data.frame}}, the first two columns shall contain the indexes, unless otherwise specified. See \code{index}}
- \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{\link{data.frame}}}
+ \item{data}{an object of class \code{data.frame} or \code{pdata.frame}. A data frame containing the variables
+ in the model. When the object is a \code{data.frame}, the first two columns shall contain the indexes, unless otherwise specified. See \code{index}}
+ \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{data.frame}}
\item{listw}{an object of class \code{listw} or a \code{matrix}. It represents the spatial weights to be used in estimation.}
\item{listw2}{an object of class \code{listw} or a
\code{matrix}. Second of set spatial weights for estimation, if
@@ -43,8 +43,8 @@
\code{"estimate"} the initial values are retreived from the estimation
of the nested specifications. Alternatively, a numeric vector can be
specified.
- x.tol: Tolerance. See \code{\link{nlminb}} for details.
- rel.tol: Relative tolerance. See \code{\link{nlminb}} for details.
+ x.tol: Tolerance. See \code{nlminb} for details.
+ rel.tol: Relative tolerance. See \code{nlminb} for details.
}
\value{
An object of class \code{"splm"}.
@@ -78,7 +78,7 @@
\author{Giovanni Millo}
-\seealso{\code{\link{spgm}}}
+\seealso{\code{spgm}}
\examples{
data(Produc, package = "Ecdat")
Modified: pkg/man/spreml.Rd
===================================================================
--- pkg/man/spreml.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/spreml.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -16,9 +16,9 @@
\arguments{
\item{formula}{a symbolic description of the model to be estimated}
- \item{data}{an object of class \code{\link{data.frame}} or \code{pdata.frame}. A data frame containing the variables
- in the model. When the object is a \code{\link{data.frame}}, the first two columns shall contain the indexes, unless otherwise specified. See \code{index}}
- \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{\link{data.frame}}}
+ \item{data}{an object of class \code{data.frame} or \code{pdata.frame}. A data frame containing the variables
+ in the model. When the object is a \code{data.frame}, the first two columns shall contain the indexes, unless otherwise specified. See \code{index}}
+ \item{index}{if not NULL (default), a character vector to identify the indexes among the columns of the \code{data.frame}}
\item{w}{an object of class \code{listw} or a \code{matrix}. It represents the spatial weights to be used in estimation.}
\item{w2}{an object of class \code{listw} or a
\code{matrix}. Second set of spatial weights for estimation, if
@@ -36,8 +36,8 @@
\code{"estimate"} the initial values are retreived from the estimation
of the nested specifications. Alternatively, a numeric vector can be
specified.}
- \item{x.tol}{control parameter for tolerance. See \code{\link{nlminb}} for details.}
- \item{rel.tol}{control parameter for relative tolerance. See \code{\link{nlminb}} for details.}
+ \item{x.tol}{control parameter for tolerance. See \code{nlminb} for details.}
+ \item{rel.tol}{control parameter for relative tolerance. See \code{nlminb} for details.}
\item{...}{additional arguments to pass over to other functions, e.g. \code{method}.}
}
\details{Second-level wrapper for estimation of random effects models
@@ -86,7 +86,7 @@
\author{Giovanni Millo}
-\seealso{\code{\link{spml}}}
+\seealso{\code{spml}}
\examples{
data(Produc, package = "Ecdat")
Modified: pkg/man/summary.splm.Rd
===================================================================
--- pkg/man/summary.splm.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/summary.splm.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -38,9 +38,9 @@
}
\seealso{
- \code{\link{spml}}, \code{\link{spgm}}, \code{\link{effects}}
+ \code{spml}, \code{spgm}
}
-\author{ Giovanni Millo \email{Giovanni\_Millo at Generali.com}, Gianfranco Piras\email{gpiras at mac.com}}
+\author{Giovanni Millo, Gianfranco Piras}
\examples{
data(Produc, package = "Ecdat")
Modified: pkg/man/usaww.Rd
===================================================================
--- pkg/man/usaww.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/usaww.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -14,9 +14,9 @@
\format{
A matrix with elements different from zero if state i and j are
-neighbors. Weights are row-standardized. According to the queen
+neighbors. Weights are row standardized. According to the queen
contiguity criterium, Arizona and Colorado are considered neighbours.}
\author{Giovanni Millo}
-\keyword{datasets}
\ No newline at end of file
+\keyword{datasets}
Modified: pkg/man/vcov.splm.Rd
===================================================================
--- pkg/man/vcov.splm.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/vcov.splm.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -29,8 +29,8 @@
data(Produc, package="Ecdat")
data(usaww)
fm <- log(gsp)~log(pcap)+log(pc)+log(emp)+unemp
-sarremod <- spml(fm, data=Produc, listw = mat2listw(usaww), model="random",
-lag=TRUE, spatial.error="none")
+sarremod <- spml(fm, data=Produc, listw = mat2listw(usaww),
+ model="random", lag=TRUE, spatial.error="none")
## compact representation of betas
library(lmtest)
coeftest(sarremod)
Modified: pkg/man/write.effects.splm.Rd
===================================================================
--- pkg/man/write.effects.splm.Rd 2013-06-27 18:39:47 UTC (rev 169)
+++ pkg/man/write.effects.splm.Rd 2013-06-29 15:34:56 UTC (rev 170)
@@ -7,8 +7,9 @@
}
\usage{
-\method{write}{effects.splm}(x, file = "effects", ncolumns = if (is.character(x)) 1 else 5,
- append = FALSE, sep = ",")
+\method{write}{effects.splm}(x, file = "effects",
+ ncolumns = if (is.character(x)) 1 else 5,
+ append = FALSE, sep = ",")
}
\arguments{
@@ -38,20 +39,22 @@
}
-\author{ Gianfranco Piras \email{gpiras at mac.com}}
+\author{Gianfranco Piras}
\seealso{
-\code{\link{spml}}
+\code{spml}
}
\examples{
-data(Produc, package = "Ecdat")
-data(usaww)
-fm <- log(gsp) ~ log(pcap) + log(pc) + log(emp) + unemp
-err <- spml(fm, data = Produc, listw = mat2listw(usaww), model="within",
- effect="time", spatial.error="b", method="eigen", Hess= FALSE)
-summary(err)
-eff <- effects(err)
-write.effects.splm(eff)
+## not run
+## data(Produc, package = "Ecdat")
+## data(usaww)
+## fm <- log(gsp) ~ log(pcap) + log(pc) + log(emp) + unemp
+## err <- spml(fm, data = Produc, listw = mat2listw(usaww),
+## model="within", effect="time", spatial.error="b",
+## method="eigen", Hess= FALSE)
+## summary(err)
+## eff <- effects(err)
+## write.effects.splm(eff)
}
\keyword{spatial}
More information about the Splm-commits
mailing list