frameCol

@JvmName(name = "frameColUnTyped")
open fun frameCol(name: String): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol("frameColumnName") }

df.select{ frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


open fun <C> frameCol(name: String): ColumnAccessor<DataFrame<C>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol("frameColumnName") }

df.select{ frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun SingleColumn<DataRow<*>>.frameCol(name: String): SingleColumn<DataFrame<*>>
@JvmName(name = "frameColUnTyped")
open fun ColumnAccessor<DataRow<*>>.frameCol(name: String): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol("frameColumnName") }

df.select{ myColumnGroup.frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol("frameColumnName") }

df.select{ myColumnGroup.frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun String.frameCol(name: String): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol("frameColumnName") }

df.select{ "myColumnGroup".frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol("frameColumnName") }

df.select{ "myColumnGroup".frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun KProperty<*>.frameCol(name: String): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol("frameColumnName") }

df.select{ Type::myColumnGroup.frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol("frameColumnName") }

df.select{ Type::myColumnGroup.frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun ColumnPath.frameCol(name: String): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol("frameColumnName") }

df.select{ "pathTo"["myColumnGroup"].frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol("frameColumnName") }

df.select{ "pathTo"["myColumnGroup"].frameCol<String>("frameColumnName") }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun frameCol(path: ColumnPath): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol("pathTo"["frameColumnName"] ) }

df.select{ frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol("pathTo"["frameColumnName"] ) }

df.select{ frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun SingleColumn<DataRow<*>>.frameCol(path: ColumnPath): SingleColumn<DataFrame<*>>
@JvmName(name = "frameColUnTyped")
open fun ColumnAccessor<DataRow<*>>.frameCol(path: ColumnPath): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol("pathTo"["frameColumnName"] ) }

df.select{ myColumnGroup.frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol("pathTo"["frameColumnName"] ) }

df.select{ myColumnGroup.frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun String.frameCol(path: ColumnPath): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol("pathTo"["frameColumnName"] ) }

df.select{ "myColumnGroup".frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol("pathTo"["frameColumnName"] ) }

df.select{ "myColumnGroup".frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun KProperty<*>.frameCol(path: ColumnPath): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol("pathTo"["frameColumnName"] ) }

df.select{ Type::myColumnGroup.frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol("pathTo"["frameColumnName"] ) }

df.select{ Type::myColumnGroup.frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun ColumnPath.frameCol(path: ColumnPath): ColumnAccessor<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol("pathTo"["frameColumnName"] ) }

df.select{ "pathTo"["myColumnGroup"].frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol("pathTo"["frameColumnName"] ) }

df.select{ "pathTo"["myColumnGroup"].frameCol<String>("pathTo"["frameColumnName"] ) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "ColumnSetDataFrameFrameColIndex")
open fun <C> ColumnSet<DataFrame<C>>.frameCol(index: Int): SingleColumn<DataFrame<C>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ colsOf<Int>().frameCol(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


open fun ColumnSet<*>.frameCol(index: Int): SingleColumn<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ colsOf<Int>().frameCol(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


@JvmName(name = "frameColUnTyped")
open fun ColumnsSelectionDsl<*>.frameCol(index: Int): SingleColumn<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol(0) }

df.select{ frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol(0) }

df.select{ frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


@JvmName(name = "frameColUnTyped")
open fun SingleColumn<DataRow<*>>.frameCol(index: Int): SingleColumn<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol(0) }

df.select{ myColumnGroup.frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol(0) }

df.select{ myColumnGroup.frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


@JvmName(name = "frameColUnTyped")
open fun String.frameCol(index: Int): SingleColumn<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol(0) }

df.select{ "myColumnGroup".frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


open fun <C> String.frameCol(index: Int): SingleColumn<DataFrame<C>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol(0) }

df.select{ "myColumnGroup".frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


@JvmName(name = "frameColUnTyped")
open fun ColumnPath.frameCol(index: Int): SingleColumn<DataFrame<*>>

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol(0) }

df.select{ "pathTo"["myColumnGroup"].frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol(0) }

df.select{ "pathTo"["myColumnGroup"].frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol(frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the frame column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol(frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the frame column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol(frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the frame column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol(frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the frame column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol(frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the frame column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColDataFrameKProperty")
open fun <C> frameCol(property: KProperty<DataFrame<C>>): SingleColumn<DataFrame<C>>
open fun <C> frameCol(property: KProperty<List<C>>): SingleColumn<DataFrame<C>>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ frameCol(Type::frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColDataFrameKProperty")
open fun <C> SingleColumn<DataRow<*>>.frameCol(property: KProperty<DataFrame<C>>): SingleColumn<DataFrame<C>>
@JvmName(name = "frameColDataFrameKProperty")
open fun <C> ColumnAccessor<DataRow<*>>.frameCol(property: KProperty<DataFrame<C>>): ColumnAccessor<DataFrame<C>>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ myColumnGroup.frameCol(Type::frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColDataFrameKProperty")
open fun <C> String.frameCol(property: KProperty<DataFrame<C>>): ColumnAccessor<DataFrame<C>>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "myColumnGroup".frameCol(Type::frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColDataFrameKProperty")
open fun <C> KProperty<*>.frameCol(property: KProperty<DataFrame<C>>): ColumnAccessor<DataFrame<C>>
open fun <C> KProperty<*>.frameCol(property: KProperty<List<C>>): ColumnAccessor<DataFrame<C>>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol(Type::frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColDataFrameKProperty")
open fun <C> ColumnPath.frameCol(property: KProperty<DataFrame<C>>): ColumnAccessor<DataFrame<C>>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].frameCol(Type::frameColumnA) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.


@JvmName(name = "frameColUnTyped")
open fun KProperty<*>.frameCol(index: Int): SingleColumn<DataFrame<*>>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol(0) }

df.select{ Type::myColumnGroup.frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.


open fun <C> KProperty<*>.frameCol(index: Int): SingleColumn<DataFrame<C>>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Frame Col

Creates a ColumnAccessor (or SingleColumn) for a frame column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for frameColumn and can be both typed and untyped (in case you're supplying a column name, -path, or index). In addition, extra runtime checks are in place to ensure that the column you specify is actually a frame column. The function can also be called on ColumnGroups to create an accessor for a frame column inside a ColumnGroup.

    

For more information: See frameCol on the documentation website.

Check out: Grammar

For example:

df.select{ frameCol<String>("frameColA") }

df.select{ frameCol(SomeType::frameColB) }

df.select{ myColumnGroup.frameCol(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.frameCol(0) }

df.select{ Type::myColumnGroup.frameCol<String>(0) }

To create a ColumnAccessor for another kind of column, take a look at the functions col, colGroup, and valueCol.

Return

A ColumnAccessor for the frame column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the value column.

Type Parameters

C

The type of the frame column.

See also

Throws

if the column with the given argument does not exist.

if the column with the given argument is not a frame column.

if the index is out of bounds.