File: range_sortna.Rd

package info (click to toggle)
r-cran-bit 4.0.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 996 kB
  • sloc: ansic: 5,083; makefile: 6
file content (40 lines) | stat: -rw-r--r-- 1,311 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bitsort.R
\name{range_sortna}
\alias{range_sortna}
\title{Prepare for sorting and get range, number of NAs and unsortedness}
\usage{
range_sortna(x, decreasing = FALSE, na.last = NA)
}
\arguments{
\item{x}{an integer vector}

\item{decreasing}{(currently only \code{FALSE} is supported)}

\item{na.last}{\code{NA} removes NAs, \code{FALSE} puts NAs at the beginning,
\code{TRUE} puts NAs at the end}
}
\value{
an integer vector with \code{NA}s are treated and an \code{attribute} \code{\link{range_na}}  with four elements \describe{
  \item{ 1 }{ min integer }
  \item{ 2 }{ max integer }
  \item{ 3 }{ number of NAs }
  \item{ 3 }{ 0 for sorted vector and 1 for \code{\link{is.unsorted}}  }
  }
}
\description{
In one pass over the vector \code{NA}s are treated according to parameter
\code{na.last} exactly like \code{\link{sort}} does, the \code{\link{range}},
number of \code{NA}s and unsortedness is determined.
}
\examples{
range_sortna(c(0L,1L,NA,2L))
range_sortna(c(2L,NA,1L,0L))
range_sortna(c(0L,1L,NA,2L), na.last=TRUE)
range_sortna(c(2L,NA,1L,0L), na.last=TRUE)
range_sortna(c(0L,1L,NA,2L), na.last=FALSE)
range_sortna(c(2L,NA,1L,0L), na.last=FALSE)
}
\seealso{
\code{\link{range_na}} and \code{\link{range_nanozero}}
}