Click or drag to resize
Frame Class
Provides static methods for creating frames, reading frame data from CSV files and database (via IDataReader). The type also provides global configuration for reflection-based expansion. [category:Frame and series operations]
Inheritance Hierarchy
SystemObject
  DeedleFrame

Namespace:  Deedle
Assembly:  Deedle (in Deedle.dll) Version: 1.2
Syntax
C#
[SerializableAttribute]
public class Frame

The Frame type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberCustomExpanders
Configures how reflection-based expansion behaves - see also `df.ExpandColumns`. This (mutable, non-thread-safe) collection lets you specify custom expansion behavior for any type. This is a dictionary with types as keys and functions that implement the expansion as values. ## Example For example, say you have a type `MyPair` with propreties `Item1` of type `int` and `Item2` of type `string` (and perhaps other properties which makes the default behavior inappropriate). You can register custom expander as: Frame.CustomExpanders.Add(typeof<MyPair>, fun v -> let a = v :?> MyPair [ "First", typeof<int>, box a.Item1; "Second", typeof<string>, box a.Item2 ] :> seq<_> ) [category:Configuration]
Public propertyStatic memberNonExpandableInterfaces
Configures how reflection-based expansion behaves - see also `df.ExpandColumns`. This (mutable, non-thread-safe) collection specifies interfaces whose implementations should not be expanded. By default, this includes collections such as IList. [category:Configuration]
Public propertyStatic memberNonExpandableTypes
Configures how reflection-based expansion behaves - see also `df.ExpandColumns`. This (mutable, non-thread-safe) collection specifies additional primitive (but reference) types that should not be expaneded. By default, this includes DateTime, string, etc. [category:Configuration]
Top
Methods
  NameDescription
Public methodStatic memberCreateEmptyR, C
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberFromArray2DT
Create data frame from a 2D array of values. The first dimension of the array is used as rows and the second dimension is treated as columns. Rows and columns of the returned frame are indexed with the element's offset in the array. ## Parameters - `array` - A two-dimensional array to be converted into a data frame
Public methodStatic memberFromColumnsTColKey, TRowKey(SeriesTColKey, ObjectSeriesTRowKey)
Public methodStatic memberFromColumnsColKey, RowKey(IEnumerableKeyValuePairColKey, ObjectSeriesRowKey)
Public methodStatic memberFromColumnsColKey, V(IEnumerableSeriesColKey, V)
Public methodStatic memberFromColumnsTColKey, TRowKey, V(SeriesTColKey, SeriesTRowKey, V)
Public methodStatic memberFromColumnsColKey, RowKey, V(IEnumerableKeyValuePairColKey, SeriesRowKey, V)
Public methodStatic memberFromRecordsT(IEnumerableT)
Creates a data frame from a sequence of any .NET objects. The method uses reflection over the specified type parameter `'T` and turns its properties to columns. The rows of the resulting frame are automatically indexed by `int`. ## Example The method can be nicely used to create a data frame using C# anonymous types (the result is a data frame with columns "A" and "B" containing two rows). [lang=csharp] var df = Frame.FromRecords(new[] { new { A = 1, B = "Test" }, new { A = 2, B = "Another"} });
Public methodStatic memberFromRecordsK, R(SeriesK, R)
Creates a data frame from a sequence of any .NET objects. The method uses reflection over the specified type parameter `'T` and turns its properties to columns.
Public methodStatic memberFromRowKeysK
Public methodStatic memberFromRowsTColKey, TRowKey(SeriesTColKey, ObjectSeriesTRowKey)
Public methodStatic memberFromRowsRowKey, ColKey(IEnumerableKeyValuePairRowKey, ObjectSeriesColKey)
Public methodStatic memberFromRowsColKey, V(IEnumerableSeriesColKey, V)
Public methodStatic memberFromRowsTColKey, TRowKey, V(SeriesTColKey, SeriesTRowKey, V)
Public methodStatic memberFromRowsRowKey, ColKey, V(IEnumerableKeyValuePairRowKey, SeriesColKey, V)
Public methodStatic memberFromValuesa, b, c(IEnumerableTuplea, b, c)
Create a data frame from a sequence of tuples containing row key, column key and a value
Public methodStatic memberFromValuesT, C, R, V(IEnumerableT, FuncT, C, FuncT, R, FuncT, V)
Create a data frame from a sequence of objects and functions that return row key, column key and value for each object in the input sequence. ## Parameters - `values` - Input sequence of objects - `colSel` - A function that returns the column key of an object - `rowSel` - A function that returns the row key of an object - `valSel` - A function that returns the value of an object
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberReadCsv(Stream, NullableBoolean, NullableBoolean, NullableInt32, String, String, String, NullableInt32, String)
Load data frame from a CSV file. The operation automatically reads column names from the CSV file (if they are present) and infers the type of values for each column. Columns of primitive types (`int`, `float`, etc.) are converted to the right type. Columns of other types (such as dates) are not converted automatically. ## Parameters * `stream` - Specifies the input stream, opened at the beginning of CSV data * `hasHeaders` - Specifies whether the input CSV file has header row (when not set, the default value is `true`) * `inferTypes` - Specifies whether the method should attempt to infer types of columns automatically (set this to `false` if you want to specify schema) * `inferRows` - If `inferTypes=true`, this parameter specifies the number of rows to use for type inference. The default value is 100. * `schema` - A string that specifies CSV schema. See the documentation for information about the schema format. * `separators` - A string that specifies one or more (single character) separators that are used to separate columns in the CSV file. Use for example `";"` to parse semicolon separated files. * `culture` - Specifies the name of the culture that is used when parsing values in the CSV file (such as `"en-US"`). The default is invariant culture. * `maxRows` - The maximal number of rows that should be read from the CSV file. * `missingValues` - An array of strings that contains values which should be treated as missing when reading the file. The default value is: "NaN"; "NA"; "#N/A"; ":"; "-"; "TBA"; "TBD". [category:Input and output]
Public methodStatic memberReadCsv(String, NullableBoolean, NullableBoolean, NullableInt32, String, String, String, NullableInt32, String)
Load data frame from a CSV file. The operation automatically reads column names from the CSV file (if they are present) and infers the type of values for each column. Columns of primitive types (`int`, `float`, etc.) are converted to the right type. Columns of other types (such as dates) are not converted automatically. ## Parameters * `location` - Specifies a file name or an web location of the resource. * `hasHeaders` - Specifies whether the input CSV file has header row (when not set, the default value is `true`) * `inferTypes` - Specifies whether the method should attempt to infer types of columns automatically (set this to `false` if you want to specify schema) * `inferRows` - If `inferTypes=true`, this parameter specifies the number of rows to use for type inference. The default value is 100. * `schema` - A string that specifies CSV schema. See the documentation for information about the schema format. * `separators` - A string that specifies one or more (single character) separators that are used to separate columns in the CSV file. Use for example `";"` to parse semicolon separated files. * `culture` - Specifies the name of the culture that is used when parsing values in the CSV file (such as `"en-US"`). The default is invariant culture. * `maxRows` - Specifies the maximum number of rows that will be read from the CSV file [category:Input and output]
Public methodStatic memberReadReader
Read data from `IDataReader`. The method reads all rows from the data reader and for each row, gets all the columns. When a value is `DBNull`, it is treated as missing. The types of created vectors are determined by the field types reported by the data reader. [category:Input and output]
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also