File: piecewiselin.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 (42 lines) | stat: -rw-r--r-- 1,039 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
\name{piecewiselin}
\alias{piecewiselin}
%- Also NEED an `\alias' for EACH other topic documented here.
\title{Piecewise linear transformation for distance matrices}
\description{
  Piecewise linear transformation for distance matrices, utility
  function for \code{geco}.
}
\usage{
piecewiselin(distmatrix, maxdist=0.1*max(distmatrix))
}
%- maybe also `usage' for other objects documented here.
\arguments{
  \item{distmatrix}{symmetric (non-negative) distance matrix.}
  \item{maxdist}{non-negative numeric. Larger distances are transformed
    to constant 1.}
}
\details{
  Transforms large distances to 1, 0 to 0 and continuously linear between 0 and
  \code{maxdist}.
}
\value{
  A symmetrical matrix.
}
  
\author{Christian Hennig
  \email{christian.hennig@unibo.it}
  \url{https://www.unibo.it/sitoweb/christian.hennig/en}}


\seealso{
  \code{\link{geco}}
}

\examples{
options(digits=4)
data(waterdist)
piecewiselin(waterdist)
}
\keyword{cluster}% at least one, from doc/KEYWORDS
\keyword{spatial}% __ONLY ONE__ keyword per line