ivwdataframe

DataFrame Module API

Functions

appendColumns(left, right[, ...])	Create a new DataFrame by appending the columns of DataFrame right to DataFrame left
appendRows(top, bottom[, matchByName])	Create a new DataFrame by appending the rows of DataFrame bottom to DataFrame top
innerJoin(*args, **kwargs)	Overloaded function.
leftJoin(left, right, keyColumn)	Create a new DataFrame by using an outer left join of DataFrame left and DataFrame right.

Classes

CategoricalColumn
Column
ColumnType	Members:
DataFrame
DataFrameFlatMultiInport
DataFrameInport
DataFrameMultiInport
DataFrameOutport
DoubleColumn
FloatColumn
IndexColumn
Int64Column
IntColumn
Size_tColumn
StringVector
UIntColumn

class ivwdataframe.CategoricalColumn

Bases: Column

__getitem__(self: ivwdataframe.CategoricalColumn, i: SupportsInt) → str

__init__(self: ivwdataframe.CategoricalColumn, arg0: str) → None

__iter__(self: ivwdataframe.CategoricalColumn) → collections.abc.Iterator[str]

__repr__(self: ivwdataframe.CategoricalColumn) → str

__setitem__(self: ivwdataframe.CategoricalColumn, i: SupportsInt, value: str) → None

add(self: ivwdataframe.CategoricalColumn, arg0: str) → None

append(*args, **kwargs)

Overloaded function.

1. append(self: ivwdataframe.CategoricalColumn, arg0: ivwdataframe.CategoricalColumn) -> None

2. append(self: ivwdataframe.CategoricalColumn, arg0: ivwdataframe.StringVector) -> None

get(self: ivwdataframe.CategoricalColumn, i: SupportsInt) → str

getAsString(self: ivwdataframe.CategoricalColumn, i: SupportsInt) → str

getId(self: ivwdataframe.CategoricalColumn, i: SupportsInt) → int

set(*args, **kwargs)

Overloaded function.

1. set(self: ivwdataframe.CategoricalColumn, i: typing.SupportsInt, value: typing.SupportsInt) -> None

2. set(self: ivwdataframe.CategoricalColumn, i: typing.SupportsInt, value: str) -> None

property categories

class ivwdataframe.Column

Bases: pybind11_object

__init__(*args, **kwargs)

__repr__(self: ivwdataframe.Column) → str

property buffer

property customRange

property dataRange

property header

property range

property size

property type

property unit

class ivwdataframe.ColumnType

Bases: pybind11_object

Members:

Index

Ordinal

Categorical

__eq__(self: object, other: object, /) → bool

__hash__(self: object, /) → int

__index__(self: ivwdataframe.ColumnType, /) → int

__init__(self: ivwdataframe.ColumnType, value: SupportsInt) → None

__int__(self: ivwdataframe.ColumnType, /) → int

__ne__(self: object, other: object, /) → bool

__repr__(self: object, /) → str

__str__(self: object, /) → str

Categorical = <ColumnType.Categorical: 2>

Index = <ColumnType.Index: 0>

Ordinal = <ColumnType.Ordinal: 1>

property name

property value

class ivwdataframe.DataFrame

Bases: pybind11_object

__getitem__(self: ivwdataframe.DataFrame, arg0: SupportsInt) → ivwdataframe.Column

__init__(self: ivwdataframe.DataFrame, size: SupportsInt = 0) → None

__iter__(self: ivwdataframe.DataFrame) → collections.abc.Iterator[ivwdataframe.Column]

__repr__(self: ivwdataframe.DataFrame) → str

addCategoricalColumn(*args, **kwargs)

Overloaded function.

1. addCategoricalColumn(self: ivwdataframe.DataFrame, header: str, size: typing.SupportsInt = 0) -> ivwdataframe.CategoricalColumn

2. addCategoricalColumn(self: ivwdataframe.DataFrame, header: str, values: ivwdataframe.StringVector) -> ivwdataframe.CategoricalColumn

addColumn(self: ivwdataframe.DataFrame, column: ivwdataframe.Column) → ivwdataframe.Column

addColumnFromBuffer(self: ivwdataframe.DataFrame, identifier: str, buffer: inviwopy.data.Buffer, unit: inviwopy.data.Unit =, range: inviwopy.glm.dvec2 | None = None) → ivwdataframe.Column

addDoubleColumn(*args, **kwargs)

Overloaded function.

1. addDoubleColumn(self: ivwdataframe.DataFrame, header: str, size: typing.SupportsInt = 0, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.DoubleColumn

2. addDoubleColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<double,std::allocator<double> >, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.DoubleColumn

addFloatColumn(*args, **kwargs)

Overloaded function.

1. addFloatColumn(self: ivwdataframe.DataFrame, header: str, size: typing.SupportsInt = 0, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.FloatColumn

2. addFloatColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<float,std::allocator<float> >, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.FloatColumn

addInt64Column(*args, **kwargs)

Overloaded function.

1. addInt64Column(self: ivwdataframe.DataFrame, header: str, size: typing.SupportsInt = 0, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.Int64Column

2. addInt64Column(self: ivwdataframe.DataFrame, header: str, data: collections.abc.Sequence[typing.SupportsInt], unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.Int64Column

addIntColumn(*args, **kwargs)

Overloaded function.

1. addIntColumn(self: ivwdataframe.DataFrame, header: str, size: typing.SupportsInt = 0, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.IntColumn

2. addIntColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<int,std::allocator<int> >, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.IntColumn

addSize_tColumn(*args, **kwargs)

Overloaded function.

1. addSize_tColumn(self: ivwdataframe.DataFrame, header: str, size: typing.SupportsInt = 0, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.Size_tColumn

2. addSize_tColumn(self: ivwdataframe.DataFrame, header: str, data: collections.abc.Sequence[typing.SupportsInt], unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.Size_tColumn

addUIntColumn(*args, **kwargs)

Overloaded function.

1. addUIntColumn(self: ivwdataframe.DataFrame, header: str, size: typing.SupportsInt = 0, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.UIntColumn

2. addUIntColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<unsigned int,std::allocator<unsigned int> >, unit: inviwopy.data.Unit = , range: inviwopy.glm.dvec2 | None = None) -> ivwdataframe.UIntColumn

column(self: ivwdataframe.DataFrame, arg0: SupportsInt) → ivwdataframe.Column

dropColumn(*args, **kwargs)

Overloaded function.

1. dropColumn(self: ivwdataframe.DataFrame, name: str) -> None

2. dropColumn(self: ivwdataframe.DataFrame, index: typing.SupportsInt) -> None

getColumn(*args, **kwargs)

Overloaded function.

1. getColumn(self: ivwdataframe.DataFrame, name: str) -> ivwdataframe.Column

2. getColumn(self: ivwdataframe.DataFrame, index: typing.SupportsInt) -> ivwdataframe.Column

getIndexColumn(self: ivwdataframe.DataFrame) → ivwdataframe.IndexColumn

indexcol(self: ivwdataframe.DataFrame) → ivwdataframe.IndexColumn

updateIndex(self: ivwdataframe.DataFrame) → None

property cols

property rows

class ivwdataframe.DataFrameFlatMultiInport

Bases: Inport

class ChangedAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameFlatMultiInport.ChangedAndDataGenerator) → tuple[bool, ivwdataframe.DataFrame]

class DataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameFlatMultiInport.DataGenerator) → ivwdataframe.DataFrame

class OutportAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameFlatMultiInport.OutportAndDataGenerator) → tuple[inviwopy.Outport, ivwdataframe.DataFrame]

__init__(self: ivwdataframe.DataFrameFlatMultiInport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x0000020EF78DCC70>) → None

changedAndData(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrameFlatMultiInport.ChangedAndDataGenerator

data(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrameFlatMultiInport.DataGenerator

getData(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrame

getSourceVectorData(self: ivwdataframe.DataFrameFlatMultiInport) → list[tuple[inviwopy.Outport, ivwdataframe.DataFrame]]

getVectorData(self: ivwdataframe.DataFrameFlatMultiInport) → list[ivwdataframe.DataFrame]

hasData(self: ivwdataframe.DataFrameFlatMultiInport) → bool

outportAndData(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrameFlatMultiInport.OutportAndDataGenerator

class ivwdataframe.DataFrameInport

Bases: Inport

class ChangedAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameInport.ChangedAndDataGenerator) → tuple[bool, ivwdataframe.DataFrame]

class DataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameInport.DataGenerator) → ivwdataframe.DataFrame

class OutportAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameInport.OutportAndDataGenerator) → tuple[inviwopy.Outport, ivwdataframe.DataFrame]

__init__(self: ivwdataframe.DataFrameInport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x0000020EF7893E30>) → None

changedAndData(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrameInport.ChangedAndDataGenerator

data(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrameInport.DataGenerator

getData(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrame

getSourceVectorData(self: ivwdataframe.DataFrameInport) → list[tuple[inviwopy.Outport, ivwdataframe.DataFrame]]

getVectorData(self: ivwdataframe.DataFrameInport) → list[ivwdataframe.DataFrame]

hasData(self: ivwdataframe.DataFrameInport) → bool

outportAndData(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrameInport.OutportAndDataGenerator

class ivwdataframe.DataFrameMultiInport

Bases: Inport

class ChangedAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameMultiInport.ChangedAndDataGenerator) → tuple[bool, ivwdataframe.DataFrame]

class DataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameMultiInport.DataGenerator) → ivwdataframe.DataFrame

class OutportAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameMultiInport.OutportAndDataGenerator) → tuple[inviwopy.Outport, ivwdataframe.DataFrame]

__init__(self: ivwdataframe.DataFrameMultiInport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x0000020EF784E170>) → None

changedAndData(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrameMultiInport.ChangedAndDataGenerator

data(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrameMultiInport.DataGenerator

getData(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrame

getSourceVectorData(self: ivwdataframe.DataFrameMultiInport) → list[tuple[inviwopy.Outport, ivwdataframe.DataFrame]]

getVectorData(self: ivwdataframe.DataFrameMultiInport) → list[ivwdataframe.DataFrame]

hasData(self: ivwdataframe.DataFrameMultiInport) → bool

outportAndData(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrameMultiInport.OutportAndDataGenerator

class ivwdataframe.DataFrameOutport

Bases: Outport

__init__(self: ivwdataframe.DataFrameOutport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x0000020EF79B8CF0>) → None

detatchData(self: ivwdataframe.DataFrameOutport) → ivwdataframe.DataFrame

getData(self: ivwdataframe.DataFrameOutport) → ivwdataframe.DataFrame

setData(self: ivwdataframe.DataFrameOutport, arg0: ivwdataframe.DataFrame) → None

class ivwdataframe.DoubleColumn

Bases: Column

__getitem__(self: ivwdataframe.DoubleColumn, i: SupportsInt) → float

__init__(self: ivwdataframe.DoubleColumn, arg0: str) → None

__iter__(self: ivwdataframe.DoubleColumn) → collections.abc.Iterator[float]

__repr__(self: ivwdataframe.DoubleColumn) → str

__setitem__(self: ivwdataframe.DoubleColumn, i: SupportsInt, value: SupportsFloat) → None

add(*args, **kwargs)

Overloaded function.

1. add(self: ivwdataframe.DoubleColumn, arg0: typing.SupportsFloat) -> None

2. add(self: ivwdataframe.DoubleColumn, arg0: str) -> None

append(self: ivwdataframe.DoubleColumn, arg0: ivwdataframe.DoubleColumn) → None

get(self: ivwdataframe.DoubleColumn, i: SupportsInt) → float

getAsString(self: ivwdataframe.DoubleColumn, i: SupportsInt) → str

set(self: ivwdataframe.DoubleColumn, i: SupportsInt, value: SupportsFloat) → None

property buffer

class ivwdataframe.FloatColumn

Bases: Column

__getitem__(self: ivwdataframe.FloatColumn, i: SupportsInt) → float

__init__(self: ivwdataframe.FloatColumn, arg0: str) → None

__iter__(self: ivwdataframe.FloatColumn) → collections.abc.Iterator[float]

__repr__(self: ivwdataframe.FloatColumn) → str

__setitem__(self: ivwdataframe.FloatColumn, i: SupportsInt, value: SupportsFloat) → None

add(*args, **kwargs)

Overloaded function.

1. add(self: ivwdataframe.FloatColumn, arg0: typing.SupportsFloat) -> None

2. add(self: ivwdataframe.FloatColumn, arg0: str) -> None

append(self: ivwdataframe.FloatColumn, arg0: ivwdataframe.FloatColumn) → None

get(self: ivwdataframe.FloatColumn, i: SupportsInt) → float

getAsString(self: ivwdataframe.FloatColumn, i: SupportsInt) → str

set(self: ivwdataframe.FloatColumn, i: SupportsInt, value: SupportsFloat) → None

property buffer

class ivwdataframe.IndexColumn

Bases: UIntColumn

__init__(self: ivwdataframe.IndexColumn, arg0: str) → None

class ivwdataframe.Int64Column

Bases: Column

__getitem__(self: ivwdataframe.Int64Column, i: SupportsInt) → int

__init__(self: ivwdataframe.Int64Column, arg0: str) → None

__iter__(self: ivwdataframe.Int64Column) → collections.abc.Iterator[int]

__repr__(self: ivwdataframe.Int64Column) → str

__setitem__(self: ivwdataframe.Int64Column, i: SupportsInt, value: SupportsInt) → None

add(*args, **kwargs)

Overloaded function.

1. add(self: ivwdataframe.Int64Column, arg0: typing.SupportsInt) -> None

2. add(self: ivwdataframe.Int64Column, arg0: str) -> None

append(self: ivwdataframe.Int64Column, arg0: ivwdataframe.Int64Column) → None

get(self: ivwdataframe.Int64Column, i: SupportsInt) → int

getAsString(self: ivwdataframe.Int64Column, i: SupportsInt) → str

set(self: ivwdataframe.Int64Column, i: SupportsInt, value: SupportsInt) → None

property buffer

class ivwdataframe.IntColumn

Bases: Column

__getitem__(self: ivwdataframe.IntColumn, i: SupportsInt) → int

__init__(self: ivwdataframe.IntColumn, arg0: str) → None

__iter__(self: ivwdataframe.IntColumn) → collections.abc.Iterator[int]

__repr__(self: ivwdataframe.IntColumn) → str

__setitem__(self: ivwdataframe.IntColumn, i: SupportsInt, value: SupportsInt) → None

add(*args, **kwargs)

Overloaded function.

1. add(self: ivwdataframe.IntColumn, arg0: typing.SupportsInt) -> None

2. add(self: ivwdataframe.IntColumn, arg0: str) -> None

append(self: ivwdataframe.IntColumn, arg0: ivwdataframe.IntColumn) → None

get(self: ivwdataframe.IntColumn, i: SupportsInt) → int

getAsString(self: ivwdataframe.IntColumn, i: SupportsInt) → str

set(self: ivwdataframe.IntColumn, i: SupportsInt, value: SupportsInt) → None

property buffer

class ivwdataframe.Size_tColumn

Bases: Column

__getitem__(self: ivwdataframe.Size_tColumn, i: SupportsInt) → int

__init__(self: ivwdataframe.Size_tColumn, arg0: str) → None

__iter__(self: ivwdataframe.Size_tColumn) → collections.abc.Iterator[int]

__repr__(self: ivwdataframe.Size_tColumn) → str

__setitem__(self: ivwdataframe.Size_tColumn, i: SupportsInt, value: SupportsInt) → None

add(*args, **kwargs)

Overloaded function.

1. add(self: ivwdataframe.Size_tColumn, arg0: typing.SupportsInt) -> None

2. add(self: ivwdataframe.Size_tColumn, arg0: str) -> None

append(self: ivwdataframe.Size_tColumn, arg0: ivwdataframe.Size_tColumn) → None

get(self: ivwdataframe.Size_tColumn, i: SupportsInt) → int

getAsString(self: ivwdataframe.Size_tColumn, i: SupportsInt) → str

set(self: ivwdataframe.Size_tColumn, i: SupportsInt, value: SupportsInt) → None

property buffer

class ivwdataframe.StringVector

Bases: pybind11_object

__bool__(self: ivwdataframe.StringVector) → bool

Check whether the list is nonempty

__contains__(self: ivwdataframe.StringVector, x: str) → bool

Return true the container contains x

__delitem__(*args, **kwargs)

Overloaded function.

1. __delitem__(self: ivwdataframe.StringVector, arg0: typing.SupportsInt) -> None

Delete the list elements at index i

2. __delitem__(self: ivwdataframe.StringVector, arg0: slice) -> None

Delete list elements using a slice object

__eq__(self: ivwdataframe.StringVector, arg0: ivwdataframe.StringVector) → bool

__getitem__(*args, **kwargs)

Overloaded function.

1. __getitem__(self: ivwdataframe.StringVector, s: slice) -> ivwdataframe.StringVector

Retrieve list elements using a slice object

2. __getitem__(self: ivwdataframe.StringVector, arg0: typing.SupportsInt) -> str

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: ivwdataframe.StringVector) -> None

2. __init__(self: ivwdataframe.StringVector, arg0: ivwdataframe.StringVector) -> None

Copy constructor

3. __init__(self: ivwdataframe.StringVector, arg0: collections.abc.Iterable) -> None

__iter__(self: ivwdataframe.StringVector) → collections.abc.Iterator[str]

__len__(self: ivwdataframe.StringVector) → int

__ne__(self: ivwdataframe.StringVector, arg0: ivwdataframe.StringVector) → bool

__repr__(self: ivwdataframe.StringVector) → str

Return the canonical string representation of this list.

__setitem__(*args, **kwargs)

Overloaded function.

1. __setitem__(self: ivwdataframe.StringVector, arg0: typing.SupportsInt, arg1: str) -> None

2. __setitem__(self: ivwdataframe.StringVector, arg0: slice, arg1: ivwdataframe.StringVector) -> None

Assign list elements using a slice object

append(self: ivwdataframe.StringVector, x: str) → None

Add an item to the end of the list

clear(self: ivwdataframe.StringVector) → None

Clear the contents

count(self: ivwdataframe.StringVector, x: str) → int

Return the number of times x appears in the list

extend(*args, **kwargs)

Overloaded function.

1. extend(self: ivwdataframe.StringVector, L: ivwdataframe.StringVector) -> None

Extend the list by appending all the items in the given list

2. extend(self: ivwdataframe.StringVector, L: collections.abc.Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: ivwdataframe.StringVector, i: SupportsInt, x: str) → None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

1. pop(self: ivwdataframe.StringVector) -> str

Remove and return the last item

2. pop(self: ivwdataframe.StringVector, i: typing.SupportsInt) -> str

Remove and return the item at index i

remove(self: ivwdataframe.StringVector, x: str) → None

Remove the first item from the list whose value is x. It is an error if there is no such item.

__hash__ = None

__pybind11_module_local_v10_msvc_md_mscver19__ = <capsule object NULL>

class ivwdataframe.UIntColumn

Bases: Column

__getitem__(self: ivwdataframe.UIntColumn, i: SupportsInt) → int

__init__(self: ivwdataframe.UIntColumn, arg0: str) → None

__iter__(self: ivwdataframe.UIntColumn) → collections.abc.Iterator[int]

__repr__(self: ivwdataframe.UIntColumn) → str

__setitem__(self: ivwdataframe.UIntColumn, i: SupportsInt, value: SupportsInt) → None

add(*args, **kwargs)

Overloaded function.

1. add(self: ivwdataframe.UIntColumn, arg0: typing.SupportsInt) -> None

2. add(self: ivwdataframe.UIntColumn, arg0: str) -> None

append(self: ivwdataframe.UIntColumn, arg0: ivwdataframe.UIntColumn) → None

get(self: ivwdataframe.UIntColumn, i: SupportsInt) → int

getAsString(self: ivwdataframe.UIntColumn, i: SupportsInt) → str

set(self: ivwdataframe.UIntColumn, i: SupportsInt, value: SupportsInt) → None

property buffer

ivwdataframe.appendColumns(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, ignoreDuplicates: bool = False, fillMissingRows: bool = False) → ivwdataframe.DataFrame

Create a new DataFrame by appending the columns of DataFrame right to DataFrame left

Parameters:

• ignoreDuplicates – duplicate columns, i.e. same column header, are ignored if true

• fillMissingRows – if true, missing rows in either DataFrame are filled with 0 or “undefined” (for categorical columns)

ivwdataframe.appendRows(top: ivwdataframe.DataFrame, bottom: ivwdataframe.DataFrame, matchByName: bool = False) → ivwdataframe.DataFrame

Create a new DataFrame by appending the rows of DataFrame bottom to DataFrame top

Parameters:

matchByName – if true, column headers are used for matching columns. Otherwise columns are matched by order (default)

ivwdataframe.innerJoin(*args, **kwargs)

Overloaded function.

1. innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: tuple[str, str] = ‘index’) -> ivwdataframe.DataFrame

   Create a new DataFrame by using an inner join of DataFrame left and DataFrame right. That is only rows with matching keys are kept.

   It is assumed that the entries in the key columns are unique. Otherwise results are undefined.

   Args:

   keyColumn: header of the column used as key for the join operation

   (default: index column)

2. innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: collections.abc.Sequence[tuple[str, str]]) -> ivwdataframe.DataFrame

   Create a new DataFrame by using an inner join of DataFrame left and DataFrame right. That is only rows with matching all keys are kept.

   It is assumed that the entries in the key columns are unique. Otherwise results are undefined.

   Args:

   keyColumn: list of headers of the columns used as key for the join operation

3. innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: tuple[str, str] = ‘index’) -> ivwdataframe.DataFrame

   Create a new DataFrame by using an outer left join of DataFrame left and DataFrame right. That is all rows of left are augmented with matching rows from right.

   It is assumed that the entries in the key columns of right are unique. Otherwise results are undefined.

   Args:

   keyColumn: header of the column used as key for the join operation

   (default: index column)

ivwdataframe.leftJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: collections.abc.Sequence[tuple[str, str]]) → ivwdataframe.DataFrame

Create a new DataFrame by using an outer left join of DataFrame left and DataFrame right. That is all rows of left are augmented with matching rows from right.

It is assumed that the entries in the key columns of right are unique. Otherwise results are undefined.

Parameters:

keyColumn – list of headers of the columns used as key for the join operation