File: booltypes.Rd

package info (click to toggle)
r-cran-bit 4.6.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,000 kB
  • sloc: ansic: 5,145; sh: 13; makefile: 6
file content (38 lines) | stat: -rw-r--r-- 1,421 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
36
37
38
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bit.R
\docType{data}
\name{booltypes}
\alias{booltypes}
\title{Boolean types}
\format{
An object of class \code{ordered} (inherits from \code{factor}) of length 6.
}
\usage{
booltypes
}
\description{
The \code{\link[=ordered]{ordered()}} factor \code{booltypes} ranks the boolean types.
}
\details{
There are currently six boolean types, \code{booltypes} is an \code{\link[=ordered]{ordered()}} vector with the
following ordinal \code{\link[=levels]{levels()}}:
\itemize{
\item nobool: non-boolean type
\item \code{\link[=logical]{logical()}}: for representing any boolean data including \code{NA}
\item \code{\link[=bit]{bit()}}: for representing dense boolean data
\item \code{\link[=bitwhich]{bitwhich()}}: for representing sparse (skewed) boolean data
\item \code{\link[=which]{which()}}: for representing sparse boolean data with few `TRUE
\item \code{\link[=ri]{ri()}}: range-indexing, for representing sparse boolean data with a single range of
\code{TRUE}
}

\code{booltypes} has a \code{\link[=names]{names()}} attribute such that elements can be selected by name.
}
\note{
do not rely on the internal integer codes of these levels, we might add-in
\code{\link[ff:hi]{hi}} later
}
\seealso{
\code{\link[=booltype]{booltype()}}, \code{\link[=is.booltype]{is.booltype()}}, \code{\link[=as.booltype]{as.booltype()}}
}
\keyword{datasets}