Data.Static: Data.Static

Description Usage Format Methods

Description

Class to provide the functionality of treating a static, finite datatable as a stream of incomming data.

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Methods

initialize(dataset = NULL, url = NULL, verbose = FALSE)

This method is used to create object of this class. One can provide either a datatable or a url pointing to a data.frame / csvfile (the class uses read.csv, and it should be compatible with the default arguments of that function). Note that the latter is only used if the provided datatable is NULL. The function will raise an error if both dataset and url are NULL. @param dataset (default = NULL) is a datatable to read the data from @param url (default = NULL) is a datatable to read the data from if no dataset is available @param verbose (default = FALSE) the verbosity to be used for logging

getNext()

Method to retrieve the next observation from the data frame. @return data.table a row from a datatable

getNextN(n = 1)

Method that returns the next n observations. This function can be used to bootstrap an initial model or to get a minibatch of observations. Note that the function will always try to return data. If one asks for n observations, it will check if there are still n new observations. If not, it will return all observations still available. If there are no observations available, it will return null. @param n (default = 1) the number of measurements requested @return datatable a row or number of rows from a datatable, NULL if n <= 0

reset

Active function. Method to reset the pointer to the beginning of the datatable.

get_all

Active function. Method to retrieve the whole dataset at once. @return data.table the data.table as set when initializing the object

get_length

Active function. Method to retrieve the number of rows in the dataframe @return integer the number of rows in the dataframe. 0 and a warning if no data is set.

get_remaining_length

Active function. Method to retrieve the number of rows still remaining in the dataframe @return integer the remaining number of rows in the dataframe.

get_currentrow

Active function. Method to retrieve pointer to the current row in the data frame. @return integer the current row in the dataframe. 1 if no data is set.


frbl/OnlineSuperLearner documentation built on Feb. 9, 2020, 9:28 p.m.