https://github.com/cran/Epi
Raw File
Tip revision: 72aab1b6b8e72d06b52dc1d5de1b383ea934f592 authored by Bendix Carstensen on 01 September 2010, 17:37:50 UTC
version 1.1.17
Tip revision: 72aab1b
Relevel.Rd
\name{Relevel}
\alias{Relevel}
\title{Reorder and combine levels of a factor}
\description{
  The levels of a factor are re-ordered so that the levels specified by
  \code{ref} is first and the others are moved down. This is useful for
  \code{contr.treatment} contrasts which take the first level as the
  reference. Levels may also be combined. 
}
\usage{
Relevel(f, ref, first = TRUE, collapse="+" )
}
\arguments{
  \item{f}{An unordered factor}
  \item{ref}{The names or numbers of levels to be the first. If \code{ref}
  is a list, factor levels mentioned in each list element are
  combined. If the list is named the names are used as new factor levels.}
  \item{first}{Should the levels mentioned in ref come before those not?}
  \item{collapse}{String used when collapsing factor levels.}
}
\value{
  An unordered factor.
}
\examples{
ff <- factor( sample( letters[1:5], 100, replace=TRUE ) )
table( ff, Relevel( ff, list( AB=1:2, "Dee"=4, c(3,5) ) ) )
table( ff, rr=Relevel( ff, list( 5:4, Z=c("c","a") ), coll="-und-", first=FALSE ) )
}
\keyword{manip}
back to top