DataFrame

@targetName("update")

Updates a column with all values that are defined in the Series.

Value Params

namedSeries: Tuple of column name to be updated and Series.

Returns

DataFrame with updated column.

Throws

MergeIndexException: If indices are not compatible.
SeriesCastException: If the data type does not match with the existing column.

Since

0.1.0

Note

The index of the Series must be included in the DataFrame.
The index of the DataFrame is not altered.

@targetName("updateOperator")

Updates a column with all values that are defined in the Series. The name of the Series defines the column.

Value Params

series: Series.

Returns

DataFrame with updated column.

Throws

MergeIndexException: If indices are not compatible.
SeriesCastException: If the data type does not match with the existing column.

Since

0.1.0

Note

The index of the Series must be included in the DataFrame.
The index of the DataFrame is not altered.

@targetName("prepend")

Concatenates the Series on the left and the DataFrame on the right hand side.

Value Params

series: Series.

Returns

DataFrame, where the Series is the first column.

Throws

MergeIndexException: If indices are not compatible.

See also

Since

0.1.0

Note

Columns with the same name are replaced by the rightmost column.
The index of the left DataFrame must be included in the right Series.
Data on the left hand side might be copied if indices are not equivalent.
The resulting index is equivalent to the right operand.
The operators | and :: are equivalent if indices on the left and right side are equal.

@targetName("prepend")

Concatenates the DataFrame on the left and the DataFrame on the right hand side.

Value Params

df: DataFrame.

Returns

DataFrame, where the left DataFrame columns are prior to the columns of the right DataFrame.

Throws

MergeIndexException: If indices are not compatible.

See also

Since

0.1.0

Note

Columns with the same name are replaced by the rightmost column.
The index of the left DataFrame must be included in the right DataFrame.
Data on the left hand side might be copied if indices are not equivalent.
The resulting index is equivalent to the right operand.
The operators | and :: are equivalent if indices on the left and right side are equal.

Appends a column if not existing in DataFrame. If the column exists, it is not altered.

Value Params

name: Column name.
series: Series.

Returns

Series with appended column on the right hand side.

Throws

MergeIndexException: If indices are not compatible. If the column exists, no exception is thrown.

Since

0.1.0

Note

The index of the Series must be included in the DataFrame.
Data of the Series might be copied if indices are not equivalent.
The index of the DataFrame is not altered.

Appends columns if not existing in DataFrame. If a column exists, it is not altered.

Value Params

series: Series to be added. The column names are taken from the Series.

Returns

Series with appended columns on the right hand side.

Throws

MergeIndexException: If indices are not compatible. If the column exists, no exception is thrown.

Since

0.1.0

Note

The index of the Series must be included in the DataFrame.
Data of the Series might be copied if indices are not equivalent.
The index of the DataFrame is not altered.

Returns a column as a Series.

Value Params

col: Column name.

Returns

Column as a Series with the name of the column.

Throws

ColumnNotFoundException: If the column is not found.

Since

0.1.0

Returns a value for a columns and a row.

Value Params

col: Column name.
row: Row.

Returns

Value as Option.

Throws

ColumnNotFoundException: If the column is not found.
IndexBoundsException: If row is not part of the base index.

Since

0.1.0

Note

For an optimal performance in a loop, first extract the column as a Series.

Returns a value for a columns and a row.

Value Params

col: Column name.
row: Row.

Returns

Value as Option. None if row is None.

Throws

ColumnNotFoundException: If the column is not found.
IndexBoundsException: If row is not part of the base index.

Since

0.1.0

Note

For an optimal performance in a loop, first extract the column as a Series.

Returns a value for a columns and a row using a default value for undefined entries.

Value Params

col: Column name.
default: Default value for undefined values.
row: Row.

Returns

Value.

Throws

ColumnNotFoundException: If the column is not found.
IndexBoundsException: If row is not part of the base index.

Since

0.1.0

Note

For an optimal performance in a loop, first extract the column as a Series.

Returns a value for a columns and a row using a default value for undefined entries.

Value Params

col: Column name.
default: Default value for undefined values.
row: Row.

Returns

Value. Default value if row is None.

Throws

ColumnNotFoundException: If the column is not found.
IndexBoundsException: If row is not part of the base index.

Since

0.1.0

Note

For an optimal performance in a loop, first extract the column as a Series.

Extracts a column and slices the index by intersecting the current index with a range.

Value Params

col: Column name.
range: Range.

Returns

Series with sliced index.

Throws

ColumnNotFoundException: If the column is not found.

See also

Since

0.1.0

Extracts a column and slices the index by intersecting the current index with a sequence of index positions.

Value Params

col: Column name.
seq: Sequence of index positions.

Returns

Series with sliced index.

Throws

ColumnNotFoundException: If the column is not found.

See also

Since

0.1.0

Extracts a column and slices the index by intersecting the current index with an array of index positions.

Value Params

array: Array of index positions.
col: Column name.

Returns

Series with sliced index.

Throws

ColumnNotFoundException: If the column is not found.

See also

Since

0.1.0

Extracts a column and slices the index by intersecting the current index with a boolean Series.

Value Params

col: Column name.
series: Boolean Series as mask, where only index positions kept that are true.

Returns

Series with sliced index.

Throws

ColumnNotFoundException: If the column is not found.

See also

Since

0.1.0

@targetName("applyCols")

Extracts DataFrame with selected columns.

Value Params

cols: Column names.

Returns

DataFrame with selected column.

Throws

ColumnNotFoundException: If one of the columns is not found.

Since

0.1.0

Determines if an object is a DataFrame.

Value Params

a: Any object.

Returns

True if the object is a DataFrame and false otherwise.

Since

0.1.0

Appends (or replaces) one columns.

Value Params

series: Series to be concatenated.

Returns

DataFrame, where the Series is appended on the right side.

Throws

MergeIndexException: If indices are not compatible.

See also

https://pan-data.org/scala/basics/dataframe-columns.html

Since

0.1.0

Note

An existing column with the same name is replaced.
The index of the Series must be included in the left DataFrame.
Series might be copied if indices are not equivalent.
The index of the DataFrame is not altered.
This operation is equivalent to the | operator.

Appends (or replaces) a columns.

Value Params

col: Name of column to be appended.
series: Series.

Returns

DataFrame, where the Series is appended on the right side.

Throws

MergeIndexException: If indices are not compatible.

See also

https://pan-data.org/scala/basics/dataframe-columns.html

Since

0.1.0

Note

An existing column with the same name is replaced.
The index of the Series must be included in the left DataFrame.
Series might be copied if indices are not equivalent.
The index of the DataFrame is not altered.
This operation is equivalent to the | operator.

Appends (or replaces) multiple columns.

Returns

Appender object which appends Series on the right side.

Throws

MergeIndexException: If indices are not compatible.

See also

https://pan-data.org/scala/basics/dataframe-columns.html

Since

0.1.0

Note

Existing columns with the same name are replaced by the rightmost column.
The index of the Series must be included in the left DataFrame.
Series might be copied if indices are not equivalent.
The index of the DataFrame is not altered.
For one column, this operation is equivalent to the | operator.

Example

 df.cols("price" -> Series(10.0, 20.0), "quantity" -> Series(5, 2))
 df.cols(Series(10.0, 20.0) as "price", Series(5, 2) as "quantity")
 df.cols(Series("price")(10.0, 20.0), Series("quantity")(5, 2))
 df.cols(price = Series(10.0, 20.0), quantity = Series(5, 2))

All columns as array of Series.

Returns: Array with all columns as Series in defined order. All Series have the same index as the DataFrame.
Since: 0.1.0

Iterates over all columns.

Returns: Iterable over all columns in defined order.
Since: 0.1.0

Sequence with column names.

Returns: Sequence with column names in defined order.
Since: 0.1.0

Determines if a column is in the DataFrame.

Value Params

col: Column name.

Returns

True if DataFrame has the column col and false otherwise.

Since

0.1.0

Prints the DataFrame as a table with an index column and annotated column types.

Value Params

colWidth: The width of each column.
n: The maximal numbers of rows.
width: The maximal width of a line.

Since

0.1.0

Drops all rows with undefined (null) values.

Returns: DataFrame restricted to rows without undefined values in all columns.
Since: 0.1.0

Drops all rows with undefined (null) values with respect to specified columns.

Value Params

cols: Columns.

Returns

DataFrame restricted to rows without undefined values in columns cols.

Throws

ColumnNotFoundException: If one of the columns cols does not exist.

Since

0.1.0

Determines if the object is a DataFrame and is equivalent. Equivalence implies:

The same index. The indices are equal if they have the same elements, the same order and the same base index.
The column names are the same (but may have different order).
The values in all columns are equal.

Value Params

df: DataFrame (or other object) to compare to.

Returns

True if equal, false otherwise.

Since

0.1.0

Definition Classes

Any

Returns a value for a columns and a row.

Value Params

col: Column name.
row: Row.

Returns

Value.

Throws

ColumnNotFoundException: If the column is not found.
NoSuchElementException: If the value is undefined or row is not in the index.

Since

0.1.0

Note

For an optimal performance in a loop, first extract the column as a Series.

Returns a value for a columns and a row.

Value Params

col: Column name.
row: Row.

Returns

Value.

Throws

ColumnNotFoundException: If the column is not found.
NoSuchElementException: If the value is undefined, row is not in the index or row is None.

Since

0.1.0

Note

For an optimal performance in a loop, first extract the column as a Series.

Groups the DataFrame by a column.

Value Params

col: Column name.

Returns

Groups.

Throws

ColumnNotFoundException: If the a column does not exist.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by columns.

Value Params

col1: Column name.
col2: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by columns.

Value Params

col1: Column name.
col2: Column name.
col3: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by a sequence of columns (of arbitrary length).

Value Params

cols: Sequence with column names.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by a typed column.

Value Params

col: Column name.

Returns

Groups.

Throws

ColumnNotFoundException: If the a column does not exist.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by typed columns.

Value Params

col1: Column name.
col2: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by typed columns.

Value Params

col1: Column name.
col2: Column name.
col3: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by a typed column including undefined values.

Value Params

col: Column name.

Returns

Groups.

Throws

ColumnNotFoundException: If the a column does not exist.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Groups the DataFrame by typed columns including undefined values.

Value Params

col1: Column name.
col2: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Groups the DataFrame by typed columns including undefined values.

Value Params

col1: Column name.
col2: Column name.
col3: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Groups the DataFrame by a column including undefined values.

Value Params

col: Column name.

Returns

Groups.

Throws

ColumnNotFoundException: If the a column does not exist.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Groups the DataFrame by columns including undefined values.

Value Params

col1: Column name.
col2: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Groups the DataFrame by columns including undefined values.

Value Params

col1: Column name.
col2: Column name.
col3: Column name.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Groups the DataFrame by a sequence of columns (of arbitrary length) including undefined values.

Value Params

cols: Sequence with column names.

Returns

Groups.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Indexes the DataFrame by a (typed) column.

Value Params

col: Column name.

Returns

DataMap.

Throws

ColumnNotFoundException: If the a column does not exist.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Indexes the DataFrame by (typed) columns.

Value Params

col1: Column name.
col2: Column name.

Returns

DataMap.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Indexes the DataFrame by (typed) columns.

Value Params

col1: Column name.
col2: Column name.
col3: Column name.

Returns

DataMap.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Indexes the DataFrame by a sequence of columns (of arbitrary length).

Value Params

cols: Sequence with column names.

Returns

DataMap.

Throws

IllegalOperation: If sequence of columns is empty.

Since

0.1.0

Note

Undefined (null) grouping values are ignored. Each Double.NaN value represents an individual group.

Groups the DataFrame by a (typed) column including undefined values.

Value Params

col: Column name.

Returns

DataMap with Option keys.

Throws

ColumnNotFoundException: If the a column does not exist.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Indexes the DataFrame by (typed) columns including undefined values.

Value Params

col1: Column name.
col2: Column name.

Returns

DataMap with Option keys.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Indexes the DataFrame by (typed) columns including undefined values.

Value Params

col1: Column name.
col2: Column name.
col3: Column name.

Returns

DataMap with Option keys.

Since

0.1.0

Note

Undefined (null) grouping are assembled in one group. Each Double.NaN value represents an individual group.

Iterator over the index.

Returns: Iterator over the index in the current order.
Since: 0.1.0

Information string describing the DataFrame.

Returns: Info string.
Since: 0.1.0

Adapter to write the DataFrame to a specific output. Use e.g.

import pd.io.parquet.implicits

to import the respective format and read a DataFrame via

df.io.parquet.write(...)

import pd.io.parquet.implicits }}} respective format and read a DataFrame via

df.io.parquet.write(...)

Returns: WriteAdapter.
See also: https://pan-data.org/scala/io/index.html
Since: 0.1.0

Performs an inner join equivalent to a SQL inner join with respect to the specified key columns.

Value Params

cols: Key columns to be joined.
df: DataFrame to be joined.

Returns

The joined DataFrame.

Throws

IllegalOperation: If not at least one key column is specified.

Since

0.1.0

Note

Columns in df are dropped that are not key columns but appear also in the original DataFrame. To keep these columns in the results, the columns must be renamed first.
The comparison of two undefined values (null) is false and does not satisfy a join condition.

Performs a left join equivalent to a SQL outer left join with respect to the specified key columns.

Value Params

cols: Key columns to be joined.
df: DataFrame to be joined.

Returns

The joined DataFrame.

Throws

IllegalOperation: If not at least one key column is specified.

Since

0.1.0

Note

Columns in df are dropped that are not key columns but appear also in the original DataFrame. To keep these columns in the results, the columns must be renamed first.
The comparison of two undefined values (null) is false and does not satisfy a join condition.

Performs an outer join equivalent to a SQL full outer join with respect to the specified key columns.

Value Params

cols: Key columns to be joined.
df: DataFrame to be joined.

Returns

The joined DataFrame.

Throws

IllegalOperation: If not at least one key column is specified.

Since

0.1.0

Note

Columns in df are dropped that are not key columns but appear also in the original DataFrame. To keep these columns in the results, the columns must be renamed first.
The comparison of two undefined values (null) is false and does not satisfy a join condition.

Performs a right join equivalent to a SQL outer right join with respect to the specified key columns.

Value Params

cols: Key columns to be joined.
df: DataFrame to be joined.

Returns

The joined DataFrame.

Throws

IllegalOperation: If not at least one key column is specified.

Since

0.1.0

Note

Columns in df are dropped that are not key columns but appear also in the original DataFrame. To keep these columns in the results, the columns must be renamed first.
The comparison of two undefined values (null) is false and does not satisfy a join condition.

Merges two DataFrame by index.

Value Params

df: DataFrame to merge.

Returns

DataFrame with all columns of df concatenated on the right side.

Since

0.1.0

Note

Columns with the same name are replaced by the rightmost column.
The order of index positions is only preserved if the indices are equal.
Use the join methods if you intend to join via column values.

Merges a Series into a DataFrame by index.

Value Params

series: Series to concatenate.

Returns

DataFrame with all columns of df concatenated on the right side.

Since

0.1.0

Note

Columns with the same name are replaced by the rightmost column.
The order of index positions is only preserved if all indices are equal.
Use the join methods if you intend to join via column values.

Number of columns.

Returns: Number of columns.
Since: 0.1.0

Number of rows.

Returns: Length of the Series, i.e. number of elements in the index.
Since: 0.1.0

Number of rows of the underlying data vectors.

Returns: Number of elements in the base index.
Since: 0.1.0

Creates a plot.

Returns: Plot object.
Since: 0.1.0

Requirement object which is used to throw exceptions if conditions are not met.

Returns: Requirement object.
Since: 0.1.0

Resets the index to a UniformIndex with index positions 0 to numRows - 1 while keeping the order of the elements. If the current index is not a uniform index, the columns are copied into new vectors with the order of the current index.

Returns: DataFrame with a UniformIndex.
See also: sortIndex for sorting the index by index positions.
Since: 0.1.0

Extracts DataFrame with selected columns.

Value Params

cols: Column names.

Returns

DataFrame with selected column.

Throws

ColumnNotFoundException: If a column is not found.

Since

0.1.0

@targetName("selectSeq")

Extracts DataFrame with selected columns.

Value Params

cols: Column names.

Returns

DataFrame with selected column.

Throws

ColumnNotFoundException: If a column is not found.

Since

0.1.0

@targetName("selectCols")

Extracts DataFrame with selected columns.

Value Params

cols: Column names.

Returns

DataFrame with selected column.

Throws

ColumnNotFoundException: If a column is not found.

Since

0.1.0

@unused

Selects a column via dot notation.

Value Params

col: Column name.

Returns

Column as a Series with the name of the column.

Throws

ColumnNotFoundException: If the column is not found.

Since

0.1.0

Example

df.myColumn

Prints the DataFrame as a table.

Value Params

annotateIndex: If true, the an index column is displayed.
annotateType: If true, the type for each column in displayed.
colWidth: The width of each column.
n: The maximal numbers of rows.
width: The maximal width of a line.

Since

0.1.0

@targetName("sortValuesCols")

Sorts the DataFrame in ascending order with respect to columns cols for supported types.

Value Params

cols: Columns which defines the order.

Returns

DataFrame with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Sorts the DataFrame with respect to columns cols for supported types.

Value Params

keys: Tuple column -> order with column name and order for sorting. Possible values are Order.asc, Order.desc, Order.ascNullsFirst and Order.descNullsFirst

Returns

Series with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Sorts the DataFrame in ascending order with respect to column col.

Value Params

col: Column which defines the order.
ordering: Implicit ordering that must exist for the type T, i.e. classes must extend the trait Ordered.

Returns

DataFrame with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Sorts the DataFrame in ascending order with respect to tow columns.

Value Params

col1: Column which defines the order.
col2: Column which defines the secondary order.
ordering1: Implicit ordering that must exist for the type T1, i.e. classes must extend the trait Ordered.
ordering2: Implicit ordering that must exist for the type T2, i.e. classes must extend the trait Ordered.

Returns

DataFrame with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Sorts the DataFrame in ascending order with respect to three columns.

Value Params

col1: Column which defines the order.
col2: Column which defines the secondary order.
col3: Column which defines the trinary order.
ordering1: Implicit ordering that must exist for the type T1, i.e. classes must extend the trait Ordered.
ordering2: Implicit ordering that must exist for the type T2, i.e. classes must extend the trait Ordered.
ordering3: Implicit ordering that must exist for the type T3, i.e. classes must extend the trait Ordered.

Returns

DataFrame with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Sorts the DataFrame with respect to a column.

Value Params

key: Tuple column -> order with column name and order for sorting. Possible values are Order.asc, Order.desc, Order.ascNullsFirst and Order.descNullsFirst. Implicit ordering must exist for the type T, i.e. classes must extend the trait Ordered.

Returns

Series with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Sorts the DataFrame with respect to a column.

Value Params

key1: Tuple column -> order with column name and order for sorting. Possible values are Order.asc, Order.desc, Order.ascNullsFirst and Order.descNullsFirst. Implicit ordering must exist for the type T, i.e. classes must extend the trait Ordered.
key2: Secondary sorting key. See key1 for details.
ordering1: Implicit ordering that must exist for the type T1, i.e. classes must extend the trait Ordered.
ordering2: Implicit ordering that must exist for the type T2, i.e. classes must extend the trait Ordered.

Returns

Series with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Sorts the DataFrame with respect to a column.

Value Params

key1: Tuple column -> order with column name and order for sorting. Possible values are Order.asc, Order.desc, Order.ascNullsFirst and Order.descNullsFirst. Implicit ordering must exist for the type T, i.e. classes must extend the trait Ordered.
key2: Secondary sorting key. See key1 for details.
key3: Trinary sorting key. See key1 for details.
ordering1: Implicit ordering that must exist for the type T1, i.e. classes must extend the trait Ordered.
ordering2: Implicit ordering that must exist for the type T2, i.e. classes must extend the trait Ordered.
ordering3: Implicit ordering that must exist for the type T3, i.e. classes must extend the trait Ordered.

Returns

Series with sorted index.

Since

0.1.0

Note

The sorting algorithm is stable.
String values are sorted lexicographically ignoring case differences (see String.compareToIgnoreCase).

Copies a column into an array.

Value Params

col: Column name.

Returns

Array of type Option[T] with numRows elements.

Since

0.1.0

Copies a column into an array.

Value Params

col: Column name.

Returns

Array of type T.

Since

0.1.0

Copies a column into a List.

Value Params

col: Column name.

Returns

List of type T.

Since

0.1.0

Copies a column into a sequence.

Value Params

col: Column name.

Returns

Sequence of type T.

Since

0.1.0

Copies a column into a List.

Value Params

col: Column name.

Returns

List of type List[T] with numRows elements.

Since

0.1.0

Copies a column into a sequence.

Value Params

col: Column name.

Returns

Sequence of type Seq[T] with numRows elements.

Since

0.1.0

Renders the DataFrame as a table using default parameters.

Returns: Formatted table.
Since: 0.1.0
Definition Classes: Any

Renders the DataFrame as a table.

Value Params

annotateIndex: If true, the an index column is displayed.
annotateType: If true, the type for each column in displayed.
colWidth: The width of each column.
indexWidth: The width of the index colum.
n: The maximal numbers of rows.
width: The maximal width of a line.

Returns

Formatted table.

Since

0.1.0

Appends row-wise one or multiple DataFrame objects. The method materializes all indices into a uniform index.

Value Params

df: DataFrame object to be appended.

Returns

DataFrame with exactly the same columns.

Throws

ColumnNotFoundException: If the DataFrame objects to be appended don't have the same columns.
SeriesCastException: If the underlying types of the columns do not match.

Since

0.1.0

Updates a column with all values that are defined in the Series.

Value Params

col: Column name to be updated.
series: Series.

Returns

DataFrame with updated column.

Throws

MergeIndexException: If indices are not compatible.
SeriesCastException: If the data type does not match with the existing column.

Since

0.1.0

Note

The index of the Series must be included in the DataFrame.
The index of the DataFrame is not altered.

Updates a column with all values that are defined in the Series. The name of the Series defines the column.

Value Params

series: Series.

Returns

DataFrame with updated column.

Throws

MergeIndexException: If indices are not compatible.
SeriesCastException: If the data type does not match with the existing column.

Since

0.1.0

Note

The index of the Series must be included in the DataFrame.
The index of the DataFrame is not altered.

Updates a columns with all values that are defined in the Series objects. The names of the Series define the column names.

Value Params

series: Series.

Returns

DataFrame with updated column.

Throws

MergeIndexException: If indices are not compatible.
SeriesCastException: If the data types do not match with the existing column.

Since

0.1.0

Note

The index of the Series must be included in the DataFrame.
The index of the DataFrame is not altered.

Counts the number of rows for unique value pairs in key columns (including undefined key values).

Value Params

cols: Key columns.

Returns

DataFrame with the key columns and a "count" column.

Since

0.1.0

Counts the number of rows for unique value pairs in key columns.

Value Params

asFraction: If true, it returns the total fraction as Double for an unique key value relative to the total number of rows (including undefined values). Otherwise the number of rows is returned as Int column.
cols: Key columns.
countCol: Name of the resulting column.
dropUndefined: If true, drops rows with undefined values in a key column (the default includes undefined values).
order: Order of the countCol column.

Returns

DataFrame with the key columns and the countCol column.

Since

0.1.0

@targetName("concat")

Concatenates the DataFrame on the left and the Series on the right hand side.

Value Params

series: Series to be concatenated.

Returns

DataFrame, where the Series is the last column.

Throws

MergeIndexException: If indices are not compatible.

See also

Since

0.1.0

Note

Columns with the same name are replaced by the rightmost column.
The index of the right Series must be included in the left DataFrame.
Data on the right hand side might be copied if indices are not equivalent.
The resulting index is equivalent to the left operand.
The operator is equivalent to the method col.

@targetName("concat")

Concatenates the DataFrame on the left and the Series on the right hand side.

Value Params

namedSeries: Tuple of column name and Series to be concatenated.

Returns

DataFrame, where the Series is the last column.

Throws

MergeIndexException: If indices are not compatible.

See also

Since

0.1.0

Note

Columns with the same name are replaced by the rightmost column.
The index of the right Series must be included in the left DataFrame.
Data on the right hand side might be copied if indices are not equivalent.
The resulting index is equivalent to the left operand.

@targetName("concat")

Concatenates the DataFrame on the left and the DataFrame on the right hand side.

Value Params

df: DataFrame to be concatenated.

Returns

DataFrame, where the left DataFrame columns are prior to the columns of the right DataFrame.

Throws

MergeIndexException: If indices are not compatible.

See also

Since

0.1.0

Note

Columns with the same name are replaced by the rightmost column.
The index of the right DataFrame must be included in the left DataFrame.
Data on the right hand side might be copied if indices are not equivalent.
The resulting index is equivalent to the left operand.

DataFrame

Value members

Concrete methods

Inherited methods