File: rangeVal.Rd

package info (click to toggle)
r-cran-bbmisc 1.13.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,256 kB
  • sloc: ansic: 176; sh: 9; makefile: 5
file content (23 lines) | stat: -rw-r--r-- 535 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rangeVal.R
\name{rangeVal}
\alias{rangeVal}
\title{Calculate range statistic}
\usage{
rangeVal(x, na.rm = FALSE)
}
\arguments{
\item{x}{[\code{numeric}]\cr
The vector.}

\item{na.rm}{[\code{logical(1)}]\cr
If \code{FALSE}, NA is returned if an NA is encountered in \code{x}.
If \code{TRUE}, NAs are disregarded.
Default is \code{FALSE}}
}
\value{
[\code{numeric(1)}].
}
\description{
A simple wrapper for \code{diff(range(x))}, so \code{max(x) - min(x)}.
}