DataBackendDataFrame: data.frame as data backend

In dymium-org/dymiumCore: A Toolkit for Building a Dynamic Microsimulation Model for Integrated Urban Modelling

Description

Data backend of data.frame. It is recommended to use DataBackendDataTable as it is more feature rich, efficient and significantly faster for many operations. This class is merely an attempt to generalise methods that belong to data.frame.

Format

R6::R6Class object inheriting from DataBackend.

Construction

x <- DataBackendDataFrame$new(.data)

• data :: data.frame
  A data.frame object.

Fields

• NULL
  

Active field (read-only)

• colnames
  The column names of the data.

Methods

• add(.data, fill = FALSE)
  (data.frame()) -> NULL
  Add data.

• get(rows, cols)
  (integer(), character()) -> data.frame()
  Get data. rows must be an integer vector, while cols can be either a character vector or an integer vector.

• remove(rows, cols)
  (integer(), integer()) -> NULL
  (abstract) Remove the data. (Developer's note: Those records that get removed should be stored in private$.removed_data see the source code of DataBackendDataTable for example.)

• view(interactive = FALSE)
  (logical(1))
  View the data. If interactive is TRUE, the data will be shown in your data tab if you are using RStudio.

• head(n = 5)
  (integer(1)) -> data.frame()
  Get the head of the data.

• ncol()
  () -> integer(1)
  Get the number of columns.

• nrow()
  () -> integer(1)
  Get the number of rows.

• get_removed()
  () -> data.frame()
  Get the removed data.

dymium-org/dymiumCore documentation built on July 18, 2021, 5:10 p.m.