datastream: Datastream objects and methods

datastreamR Documentation

Datastream objects and methods

Description

Reference object of class datastream. This is a generic class which holds general information about the data stream.
Currently streams are implemented for data in table format (streams of read.table, read.csv, read.csv2, read.delim, read.delim2), data in RAM (data.frame, matrix), data in ff (on disk).
See the documentation of datastream_file, datastream_dataframe, datastream_matrix, and datastream_ffdf

Arguments

description

The name how the stream is labelled

args

a list with arguments used to set up the stream and used in the datastream methods

Value

A class of type datastream which contains

description:

character with the name how the stream is labelled.

state:

integer with the current state at which the stream will read new instances of data

processed:

integer with the number of instances already processed

finished:

logical indicating if the stream has finished processing all the instances

args:

list with arguments passed on to the stream when it is created (e.g. arguments of read.table)

See Also

datastream_file

Examples

## Basic example, showing the general methods available for a datastream object
x <- datastream(description = "My own datastream", args = list(a = "TEST"))
x
str(x)
try(x$get_points(x))

RMOA documentation built on July 18, 2022, 1:05 a.m.