runPercentRank: Percent Rank over a Moving Window

Description Usage Arguments Details Value Note Author(s) References

View source: R/percentRank.R

Description

This function computes a running/rolling percentage rank.

Usage

1
runPercentRank(x, n = 260, cumulative = FALSE, exact.multiplier = 0.5)

Arguments

x

Object coercible to xts or matrix.

n

Number of periods to use in the window or, if cumulative=TRUE, the number of observations to use before the first result is returned. Must be between 1 and nrow(x), inclusive.

cumulative

Logical, use from-inception calculation?

exact.multiplier

The weight applied to identical values in the window. Must be between 0 and 1, inclusive. See details.

Details

The computation for a percentage rank can vary depending on the weight given to values in the window identical to the value being ranked. This weight can be set using the exact.multiplier argument which defaults to 0.5.

Value

A object of percent ranks over a n-period moving window of the same class as x and y or a vector (if try.xts fails).

Note

It may be important to note that this computation is different from the one used in Microsoft Excel's PERCENTRANK formula. Excel's computation is rather strange and gives inconsistent results as it uses interpolation to rank values that are not found within the lookback window.

Author(s)

Charlie Friedemann

References

The following site(s) were used to code/document this indicator:
https://en.wikipedia.org/wiki/Percentile_rank


TTR documentation built on Sept. 1, 2020, 5:08 p.m.

Related to runPercentRank in TTR...