File: case.Rd

package info (click to toggle)
gdata 3.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 964 kB
  • sloc: sh: 27; makefile: 15
file content (35 lines) | stat: -rw-r--r-- 1,106 bytes parent folder | download
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
\name{case}
\alias{case}
\title{Map elements of a vector according to the provided 'cases'}
\description{
  Map elements of a vector according to the provided 'cases'.  This
  function is useful for mapping discrete values to factor labels and
  is the vector equivalent to the \code{switch} function.
}
\usage{
case(x, \dots, default = NA)
}
\arguments{
  \item{x}{Vector to be converted}
  \item{\dots}{Map of alternatives, specified as "name"=value}
  \item{default}{Value to be assigned to elements of \code{x} not
    matching any of the alternatives. Defaults to \code{NA}.}
}
\details{
  This function is to \code{switch} what \code{ifelse} is to \code{if},
  and is a convenience wrapper for \code{factor}.
}
\value{
  A factor variables with each element of \code{x} mapped into the
  corresponding level of specified in the mapping.
}
\author{Gregory R. Warnes \email{greg@warnes.net}}
\seealso{\code{factor}, \code{switch}, \code{ifelse}}
\examples{
## default = NA
case(c(1,1,4,3), "a"=1, "b"=2, "c"=3)

## default = "foo"
case(c(1,1,4,3), "a"=1, "b"=2, "c"=3, default="foo")
}
\keyword{manip}