electrode_pos: Electrode position

Description Usage Arguments Value

View source: R/rwalk.R

Description

The index of the column in the random walk matrix representing the location of the electrode. The model locates the electrode in the middle of a one-dimensional string of release points. However, for performance optimization, the release bins to the right of the electrode are not populated. They are not needed for the calculation of the electrode results, since the bin values to the right and left of the electrode are symmetric.

Usage

1
electrode_pos(rw, time_column = TRUE)

Arguments

rw.

A calculated random walk matrix in the form of a data frame. The electrode bin is the middle column of the data frame.

time_column.

Logical. Indicates the presence of a time series column at the front of the data frame.

Value

Numeric. The column index indicating the location in the data frame of the electrode results.


pnojai/rwalk documentation built on Nov. 12, 2019, 7:42 a.m.