# FrameExtensions

Namespace: Deedle

Contains C# and F# extension methods for the Frame<'R, 'C> type. The members are automatically available when you import the Deedle namespace. The type contains object-oriented counterparts to most of the functionality from the Frame module.

## Data structure manipulation

Summary 1

### Static members

Static memberDescription
 ExpandColumns(frame, names) 
Signature: (frame:Frame<'R,string> * names:seq<string>) -> Frame<'R,string>
Type parameters: 'R

Creates a new data frame where the specified columns are expanded based on runtime structure of the objects they store. A column can be expanded if it is Series<string, T> or IDictionary<K, V> or if it is any .NET object with readable properties.

## Example

Given a data frame with a series that contains tuples, you can expand the tuple members and get a frame with columns S.Item1 and S.Item2:

 1: 2:  let df = frame [ "S" => series [ 1 => (1, "One"); 2 => (2, "Two") ] ] df.ExpandColumns ["S"] 

## Parameters

• names - Names of columns in the original data frame to be expanded
• frame - Input data frame whose columns will be expanded
val df : obj

Full name: docs.df
 ExpandColumns(frame, nesting, dynamic) 
Signature: (frame:Frame<'R,string> * nesting:int * dynamic:bool) -> Frame<'R,string>
Type parameters: 'R

Creates a new data frame where all columns are expanded based on runtime structure of the objects they store. The expansion is performed recrusively to the specified depth. A column can be expanded if it is Series<string, T> or IDictionary<K, V> or if it is any .NET object with readable properties.

## Parameters

• nesting - The nesting level for expansion. When set to 0, nothing is done.
 IndexColumnsWith(frame, keys) 
Signature: (frame:Frame<'R,'C> * keys:seq<'TNewRowIndex>) -> Frame<'R,'TNewRowIndex>
Type parameters: 'R, 'C, 'TNewRowIndex

Replace the column index of the frame with the provided sequence of column keys. The columns of the frame are assigned keys according to the current order, or in a non-deterministic way, if the current column index is not ordered.

## Parameters

• frame - Source data frame whose column index are to be replaced.
• keys - A collection of new column keys.
 IndexRowsOrdinally(frame) 
Signature: frame:Frame<'TRowKey,'TColumnKey> -> Frame<int,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Replace the row index of the frame with ordinarilly generated integers starting from zero. The rows of the frame are assigned index according to the current order, or in a non-deterministic way, if the current row index is not ordered.

## Parameters

• frame - Source data frame whose row index are to be replaced.
 IndexRowsUsing(frame, f) 
Signature: (frame:Frame<'R,'C> * f:Func<ObjectSeries<'C>,'R2>) -> Frame<'R2,'C>
Type parameters: 'R, 'C, 'R2

Replace the row index of the frame with a sequence of row keys generated using a function invoked on each row.

## Parameters

• frame - Source data frame whose row index are to be replaced.
• f - A function from row (as object series) to new row key value
 IndexRowsWith(frame, keys) 
Signature: (frame:Frame<'R,'C> * keys:seq<'TNewRowIndex>) -> Frame<'TNewRowIndex,'C>
Type parameters: 'R, 'C, 'TNewRowIndex

Replace the row index of the frame with the provided sequence of row keys. The rows of the frame are assigned keys according to the current order, or in a non-deterministic way, if the current row index is not ordered.

## Parameters

• frame - Source data frame whose row index are to be replaced.
• keys - A collection of new row keys.
 Nest(frame) 
Signature: frame:Frame<Tuple<'TRowKey1,'TRowKey2>,'TColumnKey> -> Series<'TRowKey1,Frame<'TRowKey2,'TColumnKey>>
Type parameters: 'TRowKey1, 'TRowKey2, 'TColumnKey

Given a data frame whose row index has two levels, create a series whose keys are the unique first level keys, and whose values are those corresponding frames selected from the original data.

 NestBy(frame, keyselector) 
Signature: (frame:Frame<'TRowKey1,'TColumnKey> * keyselector:Func<'TRowKey1,'TRowKey2>) -> Series<'TRowKey2,Frame<'TRowKey1,'TColumnKey>>
Type parameters: 'TRowKey1, 'TColumnKey, 'TRowKey2

Given a data frame whose row index has two levels, create a series whose keys are the unique results of the keyselector projection, and whose values are those corresponding frames selected from the original data.

 RealignRows(frame, keys) 
Signature: (frame:Frame<'R,'C> * keys:seq<'R>) -> Frame<'R,'C>
Type parameters: 'R, 'C

Align the existing data to a specified collection of row keys. Values in the data frame that do not match any new key are dropped, new keys (that were not in the original data frame) are assigned missing values.

## Parameters

• frame - Source data frame that is to be realigned.
• keys - A sequence of new row keys. The keys must have the same type as the original frame keys (because the rows are realigned).
 SortColumnsByKey(frame) 
Signature: frame:Frame<'TRowKey,'TColumnKey> -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Returns a data frame that contains the same data as the input, but whose columns are an ordered series. This allows using operations that are only available on indexed series such as alignment and inexact lookup.

## Parameters

• frame - Source data frame to be ordered.
 SortRows(frame, key) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * key:'TColumnKey) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Returns a data frame that contains the same data as the input, but whose rows are sorted by some column.

## Parameters

• frame - Source data frame to be ordered.
 SortRowsBy(frame, key, f) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * key:'TColumnKey * f:Func<'V,'V2>) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey, 'V, 'V2

Returns a data frame that contains the same data as the input, but whose rows are sorted by some column.

## Parameters

• frame - Source data frame to be ordered.
 SortRowsByKey(frame) 
Signature: frame:Frame<'TRowKey,'TColumnKey> -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Returns a data frame that contains the same data as the input, but whose rows are an ordered series. This allows using operations that are only available on indexed series such as alignment and inexact lookup.

## Parameters

• frame - Source data frame to be ordered.
 SortRowsWith(frame, key, cmp) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * key:'TColumnKey * cmp:Comparer<'V>) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey, 'V

Returns a data frame that contains the same data as the input, but whose rows are sorted by some column.

## Parameters

• frame - Source data frame to be ordered.
 Transpose(frame) 
Signature: frame:Frame<'TRowKey,'TColumnKey> -> Frame<'TColumnKey,'TRowKey>
Type parameters: 'TRowKey, 'TColumnKey

Returns a transposed data frame. The rows of the original data frame are used as the columns of the new one (and vice versa). Use this operation if you have a data frame and you mostly need to access its rows as a series (because accessing columns as a series is more efficient).

## Parameters

• frame - Source data frame to be transposed.
 Unnest(series) 
Signature: series:Series<'TRowKey1,Frame<'TRowKey2,'TColumnKey>> -> Frame<Tuple<'TRowKey1,'TRowKey2>,'TColumnKey>
Type parameters: 'TRowKey1, 'TRowKey2, 'TColumnKey

Given a series whose values are frames, create a frame resulting from the concatenation of all the frames' rows, with the resulting keys having two levels. This is the inverse operation to nest.

## Fancy accessors

### Static members

 Static member Description  GetRows(frame, rowKeys)  Signature: (frame:Frame<'TRowKey,'TColumnKey> * rowKeys:'TRowKey []) -> Frame<'TRowKey,'TColumnKey> Type parameters: 'TRowKey, 'TColumnKey

## Frame operations

### Static members

Static memberDescription
 PivotTable(frame, r, c, op) 
Signature: (frame:Frame<'R,'C> * r:'C * c:'C * op:Func<Frame<'R,'C>,'T>) -> Frame<'RNew,'CNew>
Type parameters: 'R, 'C, 'RNew, 'CNew, 'T

Creates a new data frame resulting from a 'pivot' operation. Consider a denormalized data frame representing a table: column labels are field names & table values are observations of those fields. pivotTable buckets the rows along two axes, according to the values of the columns r and c; and then computes a value for the frame of rows that land in each bucket.

## Parameters

• r - A column key to group on for the resulting row index
• c - A column key to group on for the resulting col index
• op - A function computing a value from the corresponding bucket frame

## Input and output

Summary 2

### Static members

Static memberDescription
 SaveCsv(...) 
Signature: (frame:Frame<'R,'C> * path:string * keyNames:seq<string> * separator:char * culture:CultureInfo) -> unit
Type parameters: 'R, 'C

Save data frame to a CSV file or to a Stream. When calling the operation, you can specify whether you want to save the row keys or not (and headers for the keys) and you can also specify the separator (use \t for writing TSV files). When specifying file name ending with .tsv, the \t separator is used automatically.

## Parameters

• path - Specifies the output file name where the CSV data should be written
• keyNames - Specifies the CSV headers for row key (or keys, for multi-level index)
• separator - Specify the column separator in the file (the default is \t for TSV files and , for CSV files)
• culture - Specify the CultureInfo object used for formatting numerical data
 SaveCsv(...) 
Signature: (frame:Frame<'R,'C> * path:string * includeRowKeys:bool * keyNames:seq<string> * separator:char * culture:CultureInfo) -> unit
Type parameters: 'R, 'C

Save data frame to a CSV file or to a Stream. When calling the operation, you can specify whether you want to save the row keys or not (and headers for the keys) and you can also specify the separator (use \t for writing TSV files). When specifying file name ending with .tsv, the \t separator is used automatically.

## Parameters

• path - Specifies the output file name where the CSV data should be written
• includeRowKeys - When set to true, the row key is also written to the output file
• keyNames - Can be used to specify the CSV headers for row key (or keys, for multi-level index)
• separator - Specify the column separator in the file (the default is \t for TSV files and , for CSV files)
• culture - Specify the CultureInfo object used for formatting numerical data
 SaveCsv(...) 
Signature: (frame:Frame<'R,'C> * writer:TextWriter * includeRowKeys:bool * keyNames:seq<string> * separator:char * culture:CultureInfo) -> unit
Type parameters: 'R, 'C

Save data frame to a CSV file or to a Stream. When calling the operation, you can specify whether you want to save the row keys or not (and headers for the keys) and you can also specify the separator (use \t for writing TSV files). When specifying file name ending with .tsv, the \t separator is used automatically.

## Parameters

• writer - Specifies the text writer to which the CSV data should be written
• includeRowKeys - When set to true, the row key is also written to the output file
• keyNames - Can be used to specify the CSV headers for row key (or keys, for multi-level index)
• separator - Specify the column separator in the file (the default is \t for TSV files and , for CSV files)
• culture - Specify the CultureInfo object used for formatting numerical data
 ToDataTable(frame, rowKeyNames) 
Signature: (frame:Frame<'R,'C> * rowKeyNames:seq<string>) -> DataTable
Type parameters: 'R, 'C

Returns the data of the frame as a .NET DataTable object. The column keys are automatically converted to strings that are used as column names. The row index is turned into an additional column with the specified name (the function takes the name as a sequence to support hierarchical keys, but typically you can write just frame.ToDataTable(["KeyName"]).

## Parameters

• rowKeyNames - Specifies the names of the row key components (or just a single row key name if the row index is not hierarchical).

## Missing values

Summary 3

### Static members

Static memberDescription
 DropSparseColumns(frame) 
Signature: frame:Frame<'TRowKey,'TColumnKey> -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Creates a new data frame that contains only those columns of the original data frame that are dense, meaning that they have a value for each row. The resulting data frame has the same number of rows, but may have fewer columns (or no columns at all).

## Parameters

• frame - An input data frame that is to be filtered
 DropSparseRows(frame) 
Signature: frame:Frame<'TRowKey,'TColumnKey> -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Creates a new data frame that contains only those rows of the original data frame that are dense, meaning that they have a value for each column. The resulting data frame has the same number of columns, but may have fewer rows (or no rows at all).

## Parameters

• frame - An input data frame that is to be filtered
 FillMissing(frame, f) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * f:Func<Series<'TRowKey,'T>,'TRowKey,'T>) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey, 'T

Fill missing values in the frame using the specified function. The specified function is called with all series and keys for which the frame does not contain value and the result of the call is used in place of the missing value.

The operation is only applied to columns (series) that contain values of the same type as the return type of the provided filling function. The operation does not attempt to convert between numeric values (so a series containing float will not be converted to a series of int).

## Parameters

• frame - An input data frame that is to be filled
• f - A function that takes a series Series<R, T> together with a key K in the series and generates a value to be used in a place where the original series contains a missing value.
 FillMissing(frame, direction) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * direction:Direction) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Fill missing values in the data frame with the nearest available value (using the specified direction). Note that the frame may still contain missing values after call to this function (e.g. if the first value is not available and we attempt to fill series with previous values). This operation can only be used on ordered frames.

## Parameters

• frame - An input data frame that is to be filled
• direction - Specifies the direction used when searching for the nearest available value. Backward means that we want to look for the first value with a smaller key while Forward searches for the nearest greater key.
 FillMissing(frame, value) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * value:'T) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey, 'T

Fill missing values of a given type in the frame with a constant value. The operation is only applied to columns (series) that contain values of the same type as the provided filling value. The operation does not attempt to convert between numeric values (so a series containing float will not be converted to a series of int).

## Parameters

• frame - An input data frame that is to be filled
• value - A constant value that is used to fill all missing values

## Other type members

### Static members

Static memberDescription
 CountColumns(frame) 
Signature: frame:Frame<'R,'C> -> int
Type parameters: 'R, 'C

Returns the total number of row keys in the specified frame. This returns the total length of the row series, including keys for which there is no value available.

 CountRows(frame) 
Signature: frame:Frame<'R,'C> -> int
Type parameters: 'R, 'C

Returns the total number of row keys in the specified frame. This returns the total length of the row series, including keys for which there is no value available.

 Diff(frame, offset) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * offset:int) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Returns a frame with columns containing difference between an original value and a value at the specified offset. For example, calling Frame.diff 1 s returns a frame where previous column values is subtracted from the current ones. In pseudo-code, the function behaves as follows:

 1:  result[k] = series[k] - series[k - offset] 

Columns that cannot be converted to float are left without a change.

## Parameters

• offset - When positive, subtracts the past values from the current values; when negative, subtracts the future values from the current values.
• frame - The input frame containing at least some float columns.
 FilterRowsBy(frame, column, value) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * column:'TColumnKey * value:obj) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey, 'V
 GetRowsAt(frame, indices) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * indices:int []) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey
 GetSlice(series, lo1, hi1, lo2, hi2) 
Signature: (series:RowSeries<('TRowKey1 * 'TRowKey2),'TColKey> * lo1:'K1 option * hi1:'K1 option * lo2:'K2 option * hi2:'K2 option) -> Frame<('TRowKey1 * 'TRowKey2),'TColKey>
Type parameters: 'TRowKey1, 'TRowKey2, 'TColKey, 'K1, 'K2
 GetSlice(series, k1, lo2, hi2) 
Signature: (series:RowSeries<('TRowKey1 * 'TRowKey2),'TColKey> * k1:'TRowKey1 * lo2:'TRowKey2 option * hi2:'TRowKey2 option) -> Frame<('TRowKey1 * 'TRowKey2),'TColKey>
Type parameters: 'TRowKey1, 'TRowKey2, 'TColKey
 GetSlice(series, lo1, hi1, k2) 
Signature: (series:RowSeries<('TRowKey1 * 'TRowKey2),'TColKey> * lo1:'TRowKey1 option * hi1:'TRowKey1 option * k2:'TRowKey2) -> Frame<('TRowKey1 * 'TRowKey2),'TColKey>
Type parameters: 'TRowKey1, 'TRowKey2, 'TColKey
 GetSlice(series, lo1, hi1, lo2, hi2) 
Signature: (series:RowSeries<('TRowKey1 * 'TRowKey2),'TColKey> * lo1:'TRowKey1 option * hi1:'TRowKey1 option * lo2:'TRowKey2 option * hi2:'TRowKey2 option) -> Frame<('TRowKey1 * 'TRowKey2),'TColKey>
Type parameters: 'TRowKey1, 'TRowKey2, 'TColKey
 GetSlice(series, lo1, hi1, lo2, hi2) 
Signature: (series:ColumnSeries<'TRowKey,('TColKey1 * 'TColKey2)> * lo1:'K1 option * hi1:'K1 option * lo2:'K2 option * hi2:'K2 option) -> Frame<'TRowKey,('TColKey1 * 'TColKey2)>
Type parameters: 'TRowKey, 'TColKey1, 'TColKey2, 'K1, 'K2
 GetSlice(series, k1, lo2, hi2) 
Signature: (series:ColumnSeries<'TRowKey,('TColKey1 * 'TColKey2)> * k1:'TColKey1 * lo2:'TColKey2 option * hi2:'TColKey2 option) -> Frame<'TRowKey,('TColKey1 * 'TColKey2)>
Type parameters: 'TRowKey, 'TColKey1, 'TColKey2
 GetSlice(series, lo1, hi1, k2) 
Signature: (series:ColumnSeries<'TRowKey,('TColKey1 * 'TColKey2)> * lo1:'TColKey1 option * hi1:'TColKey1 option * k2:'TColKey2) -> Frame<'TRowKey,('TColKey1 * 'TColKey2)>
Type parameters: 'TRowKey, 'TColKey1, 'TColKey2
 GetSlice(series, lo1, hi1, lo2, hi2) 
Signature: (series:ColumnSeries<'TRowKey,('TColKey1 * 'TColKey2)> * lo1:'TColKey1 option * hi1:'TColKey1 option * lo2:'TColKey2 option * hi2:'TColKey2 option) -> Frame<'TRowKey,('TColKey1 * 'TColKey2)>
Type parameters: 'TRowKey, 'TColKey1, 'TColKey2
 Merge(frame, rowKey, row) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * rowKey:'TRowKey * row:ISeries<'TColumnKey>) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey
 Print(frame, printTypes) 
Signature: (frame:Frame<'K,'V> * printTypes:bool) -> unit
Type parameters: 'K, 'V
 Print(frame) 
Signature: frame:Frame<'K,'V> -> unit
Type parameters: 'K, 'V
 Reduce(frame, aggregation) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * aggregation:Func<'T,'T,'T>) -> Series<'TColumnKey,'T>
Type parameters: 'TRowKey, 'TColumnKey, 'T
 Select(frame, projection) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * projection:Func<KeyValuePair<'TRowKey,ObjectSeries<'TColumnKey>>,int,'?491559>) -> Frame<'TRowKey,'?491560>
Type parameters: 'TRowKey, 'TColumnKey, '?491559, '?491560
 Select(frame, projection) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * projection:Func<KeyValuePair<'TRowKey,ObjectSeries<'TColumnKey>>,'?491554>) -> Frame<'TRowKey,'?491555>
Type parameters: 'TRowKey, 'TColumnKey, '?491554, '?491555
 SelectColumnKeys(frame, projection) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * projection:Func<KeyValuePair<'TColumnKey,OptionalValue<ObjectSeries<'TRowKey>>>,'?491568>) -> Frame<'TRowKey,'?491568>
Type parameters: 'TRowKey, 'TColumnKey, '?491568
 SelectRowKeys(frame, projection) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * projection:Func<KeyValuePair<'TRowKey,OptionalValue<ObjectSeries<'TColumnKey>>>,'?491564>) -> Frame<'?491564,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey, '?491564
 Shift(frame, offset) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * offset:int) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Returns a frame with columns shifted by the specified offset. When the offset is positive, the values are shifted forward and first offset keys are dropped. When the offset is negative, the values are shifted backwards and the last offset keys are dropped. Expressed in pseudo-code:

 1:  result[k] = series[k - offset] 

## Parameters

• offset - Can be both positive and negative number.
• frame - The input frame whose columns are to be shifted.

## Remarks

If you want to calculate the difference, e.g. df - (Frame.shift 1 df), you can use Frame.diff which will be a little bit faster.

 Sum(frame) 
Signature: frame:Frame<'R,'C> -> Series<'C,float>
Type parameters: 'R, 'C
 Where(frame, condition) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * condition:Func<KeyValuePair<'TRowKey,ObjectSeries<'TColumnKey>>,int,bool>) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Filters frame rows using the specified condtion. Returns a new data frame that contains rows for which the provided function returned false. The function is called with KeyValuePair containing the row key as the Key and Value gives access to the row series and a row index.

## Parameters

• frame - A data frame to invoke the filtering function on.
• condition - A delegate that specifies the filtering condition.
 Where(frame, condition) 
Signature: (frame:Frame<'TRowKey,'TColumnKey> * condition:Func<KeyValuePair<'TRowKey,ObjectSeries<'TColumnKey>>,bool>) -> Frame<'TRowKey,'TColumnKey>
Type parameters: 'TRowKey, 'TColumnKey

Filters frame rows using the specified condtion. Returns a new data frame that contains rows for which the provided function returned false. The function is called with KeyValuePair containing the row key as the Key and Value gives access to the row series.

## Parameters

• frame - A data frame to invoke the filtering function on.
• condition - A delegate that specifies the filtering condition.
 Window(frame, size, aggregate) 
Signature: (frame:Frame<'R,'C> * size:int * aggregate:Func<Frame<'R,'C>,'?491538>) -> Series<'R,'?491538>
Type parameters: 'R, 'C, '?491538
 Window(frame, size) 
Signature: (frame:Frame<'R,'C> * size:int) -> Series<'R,Frame<'R,'C>>
Type parameters: 'R, 'C