Datastep

Let’s begin with a brief tour of the dataStepClass. First, create an instance.

step = dataStepClass$new()

Please read the dataStepClass documentation before continuing, which is extensive.

?dataStepClass()

## Using development documentation for dataStepClass

Examples

Our example will be Euler’s method for solving differential equations. In fact, it is unimportant if you understand the method itself. The differential equation to be solved is given below: \[ \dfrac{dy}{dx} = xy \]

First, we will set initial values. The x values are the series of x values over which the method will be applied.

xFrame = data.frame(x = 0:9)

Our initial y value will only be for the first iteration of the data-step.

y_initial = data.frame(y = 1)

Now here is our stair function. First, begin is called, setting up an evaluation environment in the function’s environment(). Next, only in the first step, initialize y. Note, importantly, that without another set call later (or a manual override of continue), the data step would only run once. A lag of x is stored in all but the first step. This is important, because after the set call, x is overwritten using a slice of the dataframe above. Then, a new y is estimated using the new x, the lag of x, and the derivative estimate (in all but the first step). Next, a derivative is estimated (see equation above). Finally, we output the results.

stairs = function(...) {
  step$begin(environment())

  if (step$i == 1) step$set(y_initial)

  if (step$i > 1) lagx = x

  step$set(xFrame)
  
  if (step$i > 1) y = y + dydx*(x - lagx)
 
  dydx = x*y
  
  step$output()
  
  step$end(stairs)
}

stairs()

Let’s take a look at our results!

knitr::kable(step$results)