File: build.nblist.Rd

package info (click to toggle)
r-cran-prabclus 2.3-2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 1,392 kB
  • sloc: sh: 13; makefile: 2
file content (51 lines) | stat: -rw-r--r-- 1,896 bytes parent folder | download | duplicates (2)
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
\name{build.nblist}
\alias{build.nblist}
%- Also NEED an `\alias' for EACH other topic documented here.
\title{Generate spatial weights from prabclus neighborhood list}
\description{
  This generates a \code{listw}-object as needed for estimation of a
  simultaneous autoregression model in package \code{spdep} from a
  neighborhood list of the type generated in \code{prabinit}.  
}
\usage{
build.nblist(prabobj,prab01=NULL,style="C")
}
%- maybe also `usage' for other objects documented here.
\arguments{
  \item{prabobj}{object of class \code{prab}.}
  \item{prab01}{presence-absence matrix of same dimensions than the
  abundance matrix of \code{prabobj}. This specifies the presences and
  absences on which the presence/absence step of abundance-based tests
  is based (see details). If \code{NULL} (which is usually the only
  reasonable choice), \code{prab01} is computed in order to indicate
  the nonzeroes of \code{prabobj$prab}.}
  \item{style}{can take values "W", "B", "C", "U", and "S" though tests
    suggest that "C" should be chosen. See \code{\link[spdep]{nb2listw}}.} 
}
\value{
  A 'listw' object with the following members: 
\item{style}{see above.}
\item{neighbours}{the neighbours list in \code{spdep}-format.}
\item{weights}{the weights for the neighbours and chosen style, with
          attributes set to report the type of relationships (binary or
          general, if general the form of the glist argument), and
          style as above.} 
}

\author{Christian Hennig
  \email{christian.hennig@unibo.it}
  \url{https://www.unibo.it/sitoweb/christian.hennig/en}}

\seealso{
  \code{\link[spdep]{nb2listw}} (which is called)
}

\examples{
# Not run; requires package spdep
# data(siskiyou)
# x <- prabinit(prabmatrix=siskiyou, neighborhood=siskiyou.nb,
#             distance="logkulczynski")
# build.nblist(x)
}
\keyword{spatial}% at least one, from doc/KEYWORDS