Returns a new data frame by joining this data frame with another data frame
on the data frame's row index.
Namespace:
Extreme.DataAnalysis
Assembly:
Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
public static DataFrame<R1, string> Join<R1, R2>(
this DataFrame<R1, string> left,
JoinType joinType,
DataFrame<R2, string> right,
string key,
string leftSuffix = "_x",
string rightSuffix = "_y"
)
<ExtensionAttribute>
Public Shared Function Join(Of R1, R2) (
left As DataFrame(Of R1, String),
joinType As JoinType,
right As DataFrame(Of R2, String),
key As String,
Optional leftSuffix As String = "_x",
Optional rightSuffix As String = "_y"
) As DataFrame(Of R1, String)
public:
[ExtensionAttribute]
generic<typename R1, typename R2>
static DataFrame<R1, String^>^ Join(
DataFrame<R1, String^>^ left,
JoinType joinType,
DataFrame<R2, String^>^ right,
String^ key,
String^ leftSuffix = L"_x",
String^ rightSuffix = L"_y"
)
[<ExtensionAttribute>]
static member Join :
left : DataFrame<'R1, string> *
joinType : JoinType *
right : DataFrame<'R2, string> *
key : string *
?leftSuffix : string *
?rightSuffix : string
(* Defaults:
let _leftSuffix = defaultArg leftSuffix "_x"
let _rightSuffix = defaultArg rightSuffix "_y"
*)
-> DataFrame<'R1, string>
Parameters
- left
- Type: Extreme.DataAnalysisDataFrameR1, String
The data frame that serves as the left operand of the join operation. - joinType
- Type: Extreme.DataAnalysisJoinType
The type of join operation to perform on the indexes. - right
- Type: Extreme.DataAnalysisDataFrameR2, String
The data frame that serves as the right operand of the join operation. - key
- Type: SystemString
The key of the column in the left data frame
that is used in the joins. - leftSuffix (Optional)
- Type: SystemString
The suffix to add to the key of a column in the left frame to make it unique. - rightSuffix (Optional)
- Type: SystemString
The suffix to add to the key of a column in the right frame to make it unique.
Type Parameters
- R1
- The element type of the row index of the left data frame.
- R2
- The element type of the row index of the right data frame.
Return Value
Type:
DataFrameR1,
StringThe joined data frame.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
DataFrameR1,
String. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
Reference