Diff of /man/deckel.Rd [000000] .. [226bc8]

Switch to unified view

a b/man/deckel.Rd
1
\name{deckel}
2
\alias{deckel}
3
\title{
4
treshold an array from below and above
5
}
6
\description{
7
treshold an array from below and above
8
}
9
\usage{
10
deckel(x, lower = -Inf, upper = +Inf)
11
}
12
\arguments{
13
  \item{x}{numeric matrix}
14
  \item{lower}{numeric}
15
  \item{upper}{numeric}
16
}
17
\details{
18
The function takes the matrix and censores the values from below (if lower param is set) or from above (if upper param is set), or from both of them. If neither lower nor upper param is set or if none of the values meet the criteria for thresholding, then function returns unmodified object.
19
}
20
\value{
21
matrix
22
}
23
\author{
24
Wolfgang Huber <wolfgang.huber@embl.de>
25
}
26
\examples{
27
mat = matrix(1:40, nrow=5)
28
29
# threshold values below 5
30
deckel(mat, lower=5)
31
32
# threshold values above 15
33
deckel(mat, upper=15)
34
35
# threshold values below 5 and above 15
36
deckel(mat, lower=5, upper=15)
37
38
# threshold values below 0 and above 50 -> no thresholding will be done!
39
identical(mat, deckel(mat, lower=0, upper=50))
40
}