File: regdist.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 (57 lines) | stat: -rw-r--r-- 1,887 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
52
53
54
55
56
57
\name{regdist}
\alias{regdist}
%- Also NEED an `\alias' for EACH other topic documented here.
\title{Regression between subsets of dissimilarity matrices}
\description{
  Given two dissimilarity matrices \code{dmx} and \code{dmy} and an indicator
  vector \code{x}, this computes a standard least squares regression
  between the dissimilarity between objects indicated in \code{x}.
}

\usage{

regdist(x,dmx,dmy,xcenter=0,param)

}
%- maybe also `usage' for other objects documented here.
\arguments{
  \item{x}{vector of logicals of length of the number of objects on which
    dissimilarities \code{dmx} and \code{dmy} are based.} 
  \item{dmx}{dissimilarity matrix or object of class
    \code{\link{dist}}. Explanatory  dissimilarities.}
  \item{dmy}{dissimilarity matrix or object of class
    \code{\link{dist}}. Response dissimilarities.}
  \item{xcenter}{numeric. Dissimilarities \code{dmx} are centered by
    this, i.e., this value is subtracted from the dissimilarities before
    regression.}
  \item{param}{1 or 2 or \code{NULL}. If 1 or 2, only the first or
    second parameter (intercept or slope) of the regression is given
    out.}
}

\value{
  If \code{param=NULL}, the output object of \code{\link{lm}}. If
  \code{param=1} the intercept. If
  \code{param=2} the slope. 
}
\references{
  Hausdorf, B. and Hennig, C. (2019) Species delimitation and
  geography. Submitted.

}

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



\examples{
  options(digits=4)
  data(veronica)
  ver.geo <- coord2dist(coordmatrix=veronica.coord[1:20,],file.format="decimal2")
  vei <- prabinit(prabmatrix=veronica[1:20,],distance="jaccard")
  regdist(c(rep(TRUE,10),rep(FALSE,10)),ver.geo,vei$distmat,param=1)
}
\keyword{regression}% __ONLY ONE__ keyword per line
\keyword{spatial}% __ONLY ONE__ keyword per line