accessor_helpers: Elemental accessor helper functions

Description Usage Details See Also

Description

An accessor function is a function that retrieves variables from an object. Because most of the CAB package is programmed in an object-oriented style, accessor functions are used in almost every part of the package. Hence, these accessor functions will be documented here.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
e_get.name(elementary_obj)

e_get.fx(elementary_obj)

get.reserve(reserve_input)

get.resps(resp_input)

get.time(time_input)

get.IRI_resp_times(iri_resp_times)

bin2int(binaries)

int2bin(integers, digits)

Details

e_get.name

Get the name that was assigned to the elemental object.

e_get.fx

Get the elemental function contained in the elemental object.

get.reserve( reserve_input )

Takes a list in the input object that tracks the reserve value and returns the most recently changed reserve value. Otherwise, takes a numeric.

get.resps( resp_input )

Takes the vector resp_input and returns the number of elements that are not NAN.

get.time( time_input )

Takes the vector time_input and returns a last value that is not NAN. If all values are NAN, returns 0.

get.IRI_responses( resp_times, rft_times )

Takes a list in the input object that tracks the response times within an inter-reinforcement interval. Otherwise, takes a numeric.

bin2int

Takes a matrix of binary strings with each column corresponding to each string and the rows corresponding to the digits of each binary string.

int2bin

Takes a vector of integers with an argument digits and converts each integer into a corresponding binary string with length of digits.

See Also

class.input Many of the arguments for the helper functions come from an object of input.


Don-Li/CAB_original documentation built on May 6, 2019, 2:53 p.m.