Documentation Center

  • Trial Software
  • Product Updates

iqr

Class: timeseries

Interquartile range of timeseries data

Syntax

ts_iqr = iqr(ts)
iqr(ts, Name, Value)

Description

ts_iqr = iqr(ts) returns the interquartile range of ts.Data.

iqr(ts, Name, Value) reruns the interquatrile range of ts.Data with the specified Name, Value pairs.

Input Arguments

ts

The timeseries object for which you want the interquartile range of timeseries data.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

'MissingData'

A string specifying one of two possible values, remove or interpolate, indicating how to treat missing data during the calculation.

Default: remove

'Quality'

A vector of integers, indicating which quality codes represent missing samples (for vector data) or missing observations (for data arrays with two or more dimensions).

Output Arguments

ts_iqr

The interquartile range of ts.Data, as follows:

  • When ts.Data is a vector, ts_iqr is the difference between the 75th and the 25th percentiles of the ts.Data values.

  • When ts.Data is a matrix, and IsTimeFirst is true, and the first dimension of ts is aligned with time, then ts_iqr is a row vector containing the interquartile range of each column of ts.Data.

When ts.Data is an N-dimensional array, iqr always operates along the first nonsingleton dimension of ts.Data.

Examples

Create a time series with a missing value, represented by NaN, and then calculate the interquartile range of ts.Data after removing the missing value from the calculation:

ts = timeseries([3.0 NaN 5 6.1 8], 1:5);
iqr(ts,'MissingData','remove')

MATLAB® returns:

    3.0500

See Also

| | | | | | |

Was this topic helpful?