xmr: Generate the XMR data for any time-series data.

Description Usage Arguments Examples

View source: R/xmR.R

Description

Used to calculate XMR data.

Usage

1
xmr(df, measure, recalc = T, reuse, interval, longrun, shortrun, testing)

Arguments

df

The dataframe or tibble to calculate from. Data must be in a tidy format. At least one variable for time and one variable for measure.

measure

The column containing the measure. Must be in numeric format.

recalc

Logical: if you'd like it to recalculate bounds. Defaults to True

reuse

Logical: Should points be re-used in calculations? Defaults to False

interval

The interval you'd like to use to calculate the averages. Defaults to 5.

longrun

Used to determine rules for long run. First point is the 'n' of points used to recalculate with, and the second is to determine what qualifies as a long run. Default is c(5,8) which uses the first 5 points of a run of 8 to recalculate the bounds. If a single value is used, then that value is used twice i.e. c(6,6))

shortrun

Used to determine rules for a short run. The first point is the minimum number of points within the set to qualify a shortrun, and the second is the length of a possible set. Default is c(3,4) which states that 3 of 4 points need to pass the test to be used in a calculation. If a single value is used, then that value is used twice i.e. c(3,3))

testing

Logical to print test results

Examples

1
2
## Not run:  xmr(df, "Measure", recalc = T) 
## Not run:  xmr(df, "Measure", recalc = T, shortrun = c(3,4), longrun = c(5,8))

Zanidean/xmrr documentation built on Aug. 19, 2018, 8:30 p.m.