Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET

  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Nuget packages
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference

Skip Navigation LinksHome»Documentation»Reference»Extreme.Data.Text»FixedWidthTextFile Class»Methods»ReadDataFrame Method Overloads»ReadDataFrame(R) Method (String, FixedWidthTextOptions, String, Boolean)

FixedWidthTextFileReadDataFrameR Method (String, FixedWidthTextOptions, String, Boolean)

Extreme Optimization Numerical Libraries for .NET Professional
Reads a data frame from a file in fixed-width text format.

Namespace:  Extreme.Data.Text
Assembly:  Extreme.Data (in Extreme.Data.dll) Version: 3.1.0
Syntax

C#
VB
C++
F#
Copy
public static DataFrame<R, string> ReadDataFrame<R>(
	string path,
	FixedWidthTextOptions options,
	string keyColumn,
	bool dropKeyColumn = true
)
Public Shared Function ReadDataFrame(Of R) ( 
	path As String,
	options As FixedWidthTextOptions,
	keyColumn As String,
	Optional dropKeyColumn As Boolean = true
) As DataFrame(Of R, String)
public:
generic<typename R>
static DataFrame<R, String^>^ ReadDataFrame(
	String^ path, 
	FixedWidthTextOptions^ options, 
	String^ keyColumn, 
	bool dropKeyColumn = true
)
static member ReadDataFrame : 
        path : string * 
        options : FixedWidthTextOptions * 
        keyColumn : string * 
        ?dropKeyColumn : bool 
(* Defaults:
        let _dropKeyColumn = defaultArg dropKeyColumn true
*)
-> DataFrame<'R, string> 

Parameters

path
Type: SystemString
The path to the file.
options
Type: Extreme.Data.TextFixedWidthTextOptions
A FixedWidthTextOptions object that specifies the options to use when reading the file.
keyColumn
Type: SystemString
The name of the column that contains the column keys.
dropKeyColumn (Optional)
Type: SystemBoolean
If , the key column is not included in the returned data frame.

Type Parameters

R
The element type of the key column.

Return Value

Type: DataFrameR, String
The data frame that was read from the file pointed to by path.
Exceptions

ExceptionCondition
KeyNotFoundException

A column named keyColumn was not found in the file.

FileNotFoundException The specified file does not exist.
See Also

Reference

FixedWidthTextFile Class
ReadDataFrame Overload
Extreme.Data.Text Namespace

Copyright (c) 2004-2023 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2023, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.