getCol.DTSg: Get column vector

In gisler/DTSg: A Class for Working with Time Series Data Based on 'data.table' and 'R6' with Largely Optional Reference Semantics

Get column vector

Description

Returns the values of a column of a DTSg object.

The extract operator ([) acts as a shortcut for getCol.

Usage

## S3 method for class 'DTSg'
getCol(x, col = self$cols(class = "numeric")[1L], ...)

## S3 method for class 'DTSg'
x[...]

Arguments

x	A DTSg object (getCol S3 method only).
col	A character string specifying a column name.
...	Arguments passed on to getCol (only used by the extract operator).

Value

Returns a vector or a list in case of a list column.

See Also

cols

Examples

# new DTSg object
x <- DTSg$new(values = flow)

# get the first ten values of the "flow" column
## R6 methods
x$getCol(col = "flow")[1:10]
x$`[`("flow")[1:10]

## S3 methods
getCol(x = x, col = "flow")[1:10]
x["flow"][1:10]

gisler/DTSg documentation built on Jan. 11, 2024, 4:59 a.m.