D2MCS (version 1.0.1)

HDSubset: High Dimensional Subset handler.

Description

Creates a high dimensional subset from a HDDataset object. Only the required instances are loaded in memory to avoid unnecessary use of resources and memory.

Methods

Public methods

• HDSubset$new()

• HDSubset$getColumnNames()

• HDSubset$getNcol()

• HDSubset$getID()

• HDSubset$getIterator()

• HDSubset$isBlinded()

• HDSubset$clone()

---

Method new()

Method for initializing the object arguments during runtime.

Usage

HDSubset$new(
  file.path,
  feature.names,
  feature.id,
  start.at = 0,
  sep = ",",
  chunk.size
)

Arguments

file.path

The name of the file which the data are to be read from. Each row of the table appears as one line of the file. If it does not contain an _absolute_ path, the file name is _relative_ to the current working directory, 'getwd()'.

feature.names

A character vector specifying the name of the features that should be included in the HDDataset object.

feature.id

An integer or character indicating the column (number or name respectively) identifier. Default NULL value is valid ignores defining a identification column.

start.at

A numeric value to identify the reading start position.

sep

the field separator character. Values on each line of the file are separated by this character.

chunk.size

an integer value indicating the size of chunks taken over each iteration. By default chunk.size is defined as 10000.

---

Method getColumnNames()

Gets the name of the columns comprising the subset.

Usage

HDSubset$getColumnNames()

Returns

A character vector containing the name of each column.

---

Method getNcol()

Obtains the number of columns present in the dataset.

Usage

HDSubset$getNcol()

Returns

A numeric value or 0 if is empty.

---

Method getID()

Obtains the column identifier.

Usage

HDSubset$getID()

Returns

A character vector of size 1.

---

Method getIterator()

Creates the FIterator object.

Usage

HDSubset$getIterator(chunk.size = private$chunk.size, verbose = FALSE)

Arguments

chunk.size

An integer value indicating the size of chunks taken over each iteration. By default chunk.size is defined as 10000.

verbose

A logical value to specify if more verbosity is needed.

Returns

A FIterator object to transverse through HDSubset instances

---

Method isBlinded()

Checks if the subset contains a target class.

Usage

HDSubset$isBlinded()

Returns

A logical to specify if the subset contains a target class or not.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HDSubset$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Use HDDataset to ensure the creation of a valid HDSubset object.

See Also

HDDataset, DatasetLoader