ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

detectImportOptions

ファイルの内容に基づくインポート オプションの作成

説明

opts = detectImportOptions(filename) は、ファイル内のテーブルを検索し、テーブルをインポートするためのインポート オプションを返します。オプション オブジェクトを変更し、それを readtable とともに使用して、MATLAB® がテーブル データをインポートする方法を制御できます。返されるオプションのタイプは、ファイル拡張子によって決まります。たとえば、filename がスプレッドシート ファイルの場合、関数は SpreadsheetImportOptions オブジェクトを返します。ただし、filename がテキスト ファイルの場合、関数は DelimitedTextImportOptions オブジェクトまたは FixedWidthImportOptions オブジェクトを返します。

opts = detectImportOptions(filename,Name,Value) は、1 つ以上の Name,Value ペアの引数によって指定された追加パラメーターを使用して、ファイル内のテーブルを検索します。

すべて折りたたむ

スプレッドシート ファイルのインポート オプションを検出し、インポートする変数を指定してから、データを読み取ります。

ファイルからインポート オプション オブジェクトを作成します。

opts = detectImportOptions('patients.xls')
opts = 
  SpreadsheetImportOptions with properties:

   Sheet Properties:
                        Sheet: ''

   Replacement Properties:
                  MissingRule: 'fill'
              ImportErrorRule: 'fill'

   Variable Import Properties: Set types by name using setvartype
                VariableNames: {'LastName', 'Gender', 'Age' ... and 7 more}
                VariableTypes: {'char', 'char', 'double' ... and 7 more}
        SelectedVariableNames: {'LastName', 'Gender', 'Age' ... and 7 more}
              VariableOptions: Show all 10 VariableOptions 
	Access VariableOptions sub-properties using setvaropts/getvaropts

   Range Properties:
                    DataRange: 'A2' (Start Cell)
           VariableNamesRange: 'A1'
                RowNamesRange: ''
           VariableUnitsRange: ''
    VariableDescriptionsRange: '' 
	To display a preview of the table, use preview

オプション オブジェクトを変更してインポートする変数を指定します。

opts.SelectedVariableNames = {'Systolic','Diastolic'};

readtable をオプション オブジェクトと共に使用して、指定した変数をインポートします。

T = readtable('patients.xls',opts);
summary(T)
Variables:

    Systolic: 100x1 double

        Values:

            Min          109    
            Median       122    
            Max          138    

    Diastolic: 100x1 double

        Values:

            Min            68    
            Median       81.5    
            Max            99    

インポート オプションを作成し、複数の変数に対しデータ型を適用してから、データを読み取ります。

テキスト ファイルからインポート オプション オブジェクトを作成します。

opts = detectImportOptions('airlinesmall.csv')
opts = 
  DelimitedTextImportOptions with properties:

   Format Properties:
                    Delimiter: {','}
                   Whitespace: '\b\t '
                   LineEnding: {'\n'  '\r'  '\r\n'}
                 CommentStyle: {}
    ConsecutiveDelimitersRule: 'split'
        LeadingDelimitersRule: 'keep'
                EmptyLineRule: 'skip'
                     Encoding: 'UTF-8'

   Replacement Properties:
                  MissingRule: 'fill'
              ImportErrorRule: 'fill'
             ExtraColumnsRule: 'addvars'

   Variable Import Properties: Set types by name using setvartype
                VariableNames: {'Year', 'Month', 'DayofMonth' ... and 26 more}
                VariableTypes: {'double', 'double', 'double' ... and 26 more}
        SelectedVariableNames: {'Year', 'Month', 'DayofMonth' ... and 26 more}
              VariableOptions: Show all 29 VariableOptions 
	Access VariableOptions sub-properties using setvaropts/getvaropts

   Location Properties:
                    DataLines: [2 Inf]
            VariableNamesLine: 1
               RowNamesColumn: 0
            VariableUnitsLine: 0
     VariableDescriptionsLine: 0 
	To display a preview of the table, use preview

変数 TaxiInTaxiOutType プロパティを確認します。

getvaropts(opts,{'TaxiIn','TaxiOut'})
ans = 
  1x2 TextVariableImportOptions array with properties:

    Name
    Type
    FillValue
    TreatAsMissing
    QuoteRule
    Prefixes
    Suffixes
    EmptyFieldRule
    WhitespaceRule

変数 TaxiInTaxiOut の型を double に変更します。

 opts = setvartype(opts,{'TaxiIn','TaxiOut'},'double');

インポートして確認する変数のサブセットを指定します。

opts.SelectedVariableNames = {'TaxiIn','TaxiOut'};

関数 readtable をオプション オブジェクトと共に使用して、選択した変数をインポートします。テーブルの概要を表示します。

T = readtable('airlinesmall.csv',opts);
summary(T)
Variables:

    TaxiIn: 123523x1 double

        Values:

            Min            0      
            Median         5      
            Max            1451   
            NumMissing     37383  

    TaxiOut: 123523x1 double

        Values:

            Min             0      
            Median          13     
            Max             755    
            NumMissing      37364  

インポート オプションを指定して、テキスト データを string データ型としてインポートします。

ファイルのオプション オブジェクトを作成します。

opts = detectImportOptions('outages.csv');

インポートする変数を readtable を使って指定してから、概要を表示します。選択された変数のデータ型は char です。

opts.SelectedVariableNames = {'Region','Cause'};
T = readtable('outages.csv',opts);
summary(T)
Variables:

    Region: 1468x1 cell array of character vectors

    Cause: 1468x1 cell array of character vectors

テキスト データを string データ型としてインポートしてから、名前と値のペア TextType を指定してインポート オプションを作成します。

opts = detectImportOptions('outages.csv','TextType','string');

インポートする変数を readtable を使って指定してから、概要を表示します。ここで、選択された変数のデータ型は string です。

opts.SelectedVariableNames = {'Region','Cause'};
T = readtable('outages.csv',opts);
summary(T)
Variables:

    Region: 1468x1 string

    Cause: 1468x1 string

入力引数

すべて折りたたむ

読み取るファイルの名前。文字ベクトルまたは string スカラーとして指定します。

ファイルの場所によって、filename は次のいずれかの形式をとります。

場所

形式

現在のフォルダー、または MATLAB パス上のフォルダー

ファイル名を filename で指定します。

例: 'myFile.txt'

フォルダー内のファイル

ファイルが現在のフォルダーまたは MATLAB パス上のフォルダーにない場合は、filename に絶対パス名または相対パス名を指定します。

例: 'C:\myFolder\myFile.xlsx'

例: '\imgDir\myFile.txt'

リモートの場所

リモートの場所に保存されたファイルの場合、filename は次の形式の国際化リソース識別子 (IRI) として指定されたファイルの絶対パスを含まなければなりません。

scheme_name://path_to_file/my_file.ext

リモートの場所に基づいて、scheme_name には次の表の値のいずれかを指定できます。

リモートの場所scheme_name
Amazon S3™s3
Windows Azure® Blob Storagewasbwasbs
HDFS™hdfs

詳細については、リモート データの操作を参照してください。

例: 's3://bucketname/path_to_file/my_file.csv'

filename にファイル拡張子が含まれる場合、detectImportOptions は拡張子からファイル形式を判別します。それ以外の場合は、'FileType' の名前と値のペアを指定してファイルの種類を指定しなければなりません。

関数 detectImportOptions は、次のファイル拡張子をサポートしています。.txt.dat.csv.xls.xlsb.xlsm.xlsx.xltm.xltx および .ods

メモ

ファイル拡張子 .xlsb.ods は、Excel® for Windows® を備えたプラットフォームでのみサポートされます。

データ型: char | string

名前と値のペアの引数

オプションの Name,Value の引数ペアをコンマ区切りで指定します。Name は引数名で、Value は対応する値です。Name は引用符で囲まなければなりません。Name1,Value1,...,NameN,ValueN のように、複数の名前と値のペアの引数を任意の順序で指定できます。

例: 'FileType','text'

パラメーター

すべて折りたたむ

ファイルの種類。'FileType''text' または 'spreadsheet' のいずれかで構成されるコンマ区切りのペアとして指定します。

filename にファイル拡張子が含まれない場合、または次の拡張子以外の場合は、名前と値のペアの引数 'FileType' を指定します。

  • 区切りテキスト ファイルの場合、.txt.dat または .csv

  • スプレッドシート ファイルの場合、.xls.xlsb.xlsm.xlsx.xltm, .xltx または .ods

メモ

ファイル拡張子 .xlsb.ods は、Excel for Windows を備えたプラットフォームでのみサポートされます。

例: 'FileType','text'

データ型: char | string

インポートされるテキスト データの型。'TextType''char' または 'string' で構成されるコンマ区切りのペアとして指定します。

  • 'char' — テキスト データを文字ベクトルとして MATLAB にインポートします。

  • 'string' — テキスト データを string 配列として MATLAB にインポートします。

例: 'TextType','char'

インポートされる日付と時刻のデータの型。'DatetimeType' と、'datetime''text''exceldatenum' のいずれかの値で構成されるコンマ区切りのペアとして指定します。値 'exceldatenum' はスプレッドシート ファイルのみに適用され、テキスト ファイルに対しては有効ではありません。

インポートされる日付と時刻のデータの型
'datetime'

MATLAB の datetime データ型

詳細については、datetime を参照してください。

'text'

'DatetimeType''text' として指定した場合、インポートされる日付と時刻のデータの型は 'TextType' パラメーターで指定された値によって決まります。

  • 'TextType''char' に設定されている場合、インポート関数は日付を文字ベクトルの cell 配列として返します。

  • 'TextType''string' に設定されている場合、インポート関数は日付を string の配列として返します。

'exceldatenum'

Excel のシリアル日付値

シリアル日付値は、指定された基準日からの日数に等しい単一の数値です。Excel のシリアル日付値では MATLAB のシリアル日付値とは異なる基準日が使用されています。Excel の日付の詳細については、https://support.microsoft.com/en-us/kb/214330 を参照してください。

データ型: char | string

必要な変数の数。'ExpectedNumVariables' と正の整数で構成されるコンマ区切りのペアとして指定します。指定しない場合、変数の数はインポート関数により自動検出されます。

データ型: single | double

テキストまたはスプレッドシート ファイルから読み取るデータの部分。'Range' と、次のいずれかの形式をとる文字ベクトル、string スカラー、または数値ベクトルで構成されるコンマ区切りのペアとして指定します。

Range の指定方法説明

開始セル

'Cell' または [row col]

文字ベクトル、string スカラー、または 2 要素数値ベクトルとして、データの開始セルを指定します。

  • Excel の A1 表記法を使用した列の文字および行番号を含む文字ベクトルまたは string スカラー。たとえば、A5 は列 A と行 5 が交わる場所にあるセルの識別子です。

  • 開始行と開始列を示す [row col] 形式の 2 要素数値ベクトル。

開始セルを使用して、インポート関数は、インポートを開始セルで開始し、最後の空の行またはフッター範囲で終了することで、データの範囲を自動的に検出します。

例: 'A5' または [5 1]

四角形の範囲

'Corner1:Corner2' または [r1 c1 r2 c2]

次の四角形の範囲フォームのいずれかを使用して、読み取る範囲を正確に指定します。

  • 'Corner1:Corner2' — 読み取る領域を定義する 2 つの対角 Corner1 および Corner2 (Excel の A1 表記法) を使用して範囲を指定します。たとえば、'C2:N15' のようになります。

  • [r1 c1 r2 c2] — 開始行、開始列、終了行および終了列を含む 4 要素数値ベクトルを使用して範囲を指定します。たとえば、[2 3 15 13] のようになります。

インポート関数は、指定された範囲内に含まれるデータのみを読み取ります。指定された範囲内の空のフィールドは欠損セルとしてインポートされます。

行範囲または列範囲

'Row1:Row2' または 'Column1:Column2'

Excel の行番号を使用して、開始行と終了行を示して範囲を指定します。

インポート関数は、指定された行範囲を使用して、最初の空でない列からデータの最後まで読み取ることにより、列の範囲を自動的に検出し、列ごとに 1 つの変数を作成します。

例: '5:500'

あるいは、Excel の列の文字または数字を使用して開始列と終了列を示して、範囲を指定します。

インポート関数は、指定された列範囲を使用して、最初の空でない行からデータの最後またはフッター範囲まで読み取ることにより、行の範囲を自動的に検出します。

指定された範囲の列数は ExpectedNumVariables プロパティで指定された数と一致しなければなりません。

例: 'A:K'

開始行番号

n

正のスカラー行インデックスを使用して、データを含む最初の行を指定します。

インポート関数は、指定された行インデックスを使用して、指定された最初の行からデータの最後またはフッター範囲まで読み取ることにより、データの範囲を自動的に検出します。

例: 5

Excel の名前付き範囲

'NamedRange'

Excel では、スプレッドシート内の範囲を表す名前を作成できます。たとえば、スプレッドシートの四角形部分を選択して 'myTable' という名前を付けることができます。スプレッドシート内にそのような名前付き範囲が存在する場合、インポート関数はその名前を使用して範囲を読み取ることができます。

例: 'Range','myTable'

指定なしまたは空

''

指定しない場合、使用範囲はインポート関数により自動検出されます。

例: 'Range',''

メモ: "使用範囲" とは、スプレッドシート内で実際にデータが含まれている四角形部分を指します。インポート関数は、データを含まない先頭と末尾の行と列をすべてトリミングして、使用範囲を自動的に検出します。空白のみのテキストはデータと見なされ、使用範囲内に取得されます。

データ型: char | string | double

ファイルのヘッダーの行数。'NumHeaderLines' と正の整数で構成されるコンマ区切りのペアとして指定します。指定しない場合、ファイル ヘッダーの行数はインポート関数により自動検出されます。

例: 'NumHeaderLines',7

データ型: single | double

最初の行を変数名として読み取るかどうかを示すインジケーター。'ReadVariableNames' と、true または false で構成されるコンマ区切りのペアとして指定します。指定しない場合、readtable は変数名の有無を自動的に検出します。

インジケーター

説明

true

読み取る領域の最初の行にテーブルの変数名が含まれている場合に使用します。readtable は、検出した変数名を使用して T の各列に変数を作成します。

false

読み取る領域の最初の行にテーブルのデータが含まれている場合に使用します。readtable は、'Var1',...,'VarN' の形式で既定の変数名を作成します。ここで、N は変数の数です。

指定なし 指定しない場合、インポート関数は true または false を自動的に検出し、それに応じて続行します。

データ型: logical

最初の列を行名として読み取るかどうかを示すインジケーター。'ReadRowNames' と、false または true で構成されるコンマ区切りのペアとして指定します。

インジケーター

説明

false

読み取る領域の最初の列にテーブルの行名ではなくデータが含まれている場合に使用します。

true

読み取る領域の最初の列にテーブルの行名が含まれている場合に使用します。

指定なし指定のない場合、インポート関数は false と見なします。

データ型: logical

スプレッドシート ファイル専用のパラメーター

すべて折りたたむ

読み取り元のシート。空の文字配列、シート名を含む文字ベクトルまたは string スカラー、あるいはシート インデックスを示す正の整数スカラーとして指定します。インポート関数は Sheet プロパティに指定された値に基づいて、表に説明されているように動作します。

指定動作
'' (既定)1 番目のシートからデータをインポートします。
名前スプレッドシート ファイル内のシートの順序に関係なく、一致する名前のシートからデータをインポートします。
整数スプレッドシート ファイル内のシート名に関係なく、整数で示された位置にあるシートからデータをインポートします。

データ型: char | string | single | double

テキスト ファイル専用のパラメーター

すべて折りたたむ

フィールドの区切り記号。文字ベクトル、string スカラー、文字ベクトルの cell 配列、または string 配列として指定します。

例: 'Delimiter','|'

例: 'Delimiter',{';','*'}

データ型: char | string | cell

空白として扱う文字。1 文字以上が含まれる文字ベクトルまたは string スカラーとして指定します。

例: 'Whitespace',' _'

例: 'Whitespace','?!.,'

行末の文字。文字ベクトル、string スカラー、文字ベクトルの cell 配列、または string 配列として指定します。

例: 'LineEnding','\n'

例: 'LineEnding','\r\n'

例: 'LineEnding',{'\b',':'}

データ型: char | string | cell

ファイルに関連付けられた文字エンコード スキーム。'Encoding''system' で構成されるコンマ区切りのペア、または次の表に示す値のいずれかなどの、標準の文字エンコード スキーム名として指定します。

'Big5'

'ISO-8859-1'

'windows-847'

'Big5-HKSCS'

'ISO-8859-2'

'windows-949'

'CP949'

'ISO-8859-3'

'windows-1250'

'EUC-KR'

'ISO-8859-4'

'windows-1251'

'EUC-JP'

'ISO-8859-5'

'windows-1252'

'EUC-TW'

'ISO-8859-6'

'windows-1253'

'GB18030'

'ISO-8859-7'

'windows-1254'

'GB2312'

'ISO-8859-8'

'windows-1255'

'GBK'

'ISO-8859-9'

'windows-1256'

'IBM866'

'ISO-8859-11'

'windows-1257'

'KOI8-R'

'ISO-8859-13'

'windows-1258'

'KOI8-U'

'ISO-8859-15'

'US-ASCII'

 

'Macintosh'

'UTF-8'

 

'Shift_JIS'

 

例: 'Encoding','system' はシステムの既定のエンコードを使用します。

データ型: char | string

コメントのスタイル。文字ベクトル、string スカラー、文字ベクトルの cell 配列、または string 配列として指定します。

たとえば、パーセント記号に続く同じ行のテキストを無視するには、CommentStyle'%' に指定します。

例: 'CommentStyle',{'/*'}

データ型: char | string | cell

テキスト ファイルからの duration データの出力データ型。'DurationType''duration' または 'text' のいずれかで構成されるコンマ区切りのペアとして指定します。

インポートされる duration データの型
'duration'

MATLAB の duration データ型

詳細については、duration を参照してください。

'text'

'DurationType''text' として指定した場合、インポートされる duration データの型は 'TextType' パラメーターで指定された値によって決まります。

  • 'TextType''char' に設定されている場合、インポート関数は duration データを文字ベクトルの cell 配列として返します。

  • 'TextType''string' に設定されている場合、インポート関数は duration データを string の配列として返します。

データ型: char | string

連続する区切り記号を処理する方法。次の表のいずれかの値として指定します。

連続する区切り記号のルール動作
'split'連続する区切り記号を複数のフィールドに分割します。
'join'複数の区切り記号を結合して 1 つの区切り記号にします。
'error'エラーを返し、インポート操作を中止します。

データ型: char | string

先頭の区切り記号を管理する手順。次の表のいずれかの値として指定します。

先頭の区切り記号のルール動作
'keep'区切り記号を維持します。
'ignore'区切り記号を無視します。
'error'エラーを返し、インポート操作を中止します。

欠損データとして解釈するテキスト。文字ベクトル、string スカラー、文字ベクトルの cell 配列、または string 配列として指定します。

インポート関数は、欠損インスタンスを見つけると、MissingRule プロパティ内の指定を使用して、適切なアクションを決定します。

例: 'TreatAsMissing',{'NA','TBD'} は、インポート関数に NA または TBD のすべての出現を欠損フィールドとして処理するように指示します。

データ型: char | string | cell

数値変数内の 3 桁ごとの区切りを示す文字。文字ベクトルまたは string スカラーとして指定します。3 桁ごとの区切り文字は視覚的な区切りとして機能し、数値を 3 桁ごとにグループ化します。インポート関数は、ThousandsSeparator プロパティの文字を使用して、インポートされる数値を解釈します。

データ型: char | string

数値変数内の小数点の区切りを示す文字。文字ベクトルまたは string スカラーとして指定します。インポート関数は、DecimalSeparator プロパティを使用して、数値の整数部分と小数部分を区別します。

整数データ型に変換すると、小数部分をもつ数値は最も近い整数に丸められます。

データ型: char | string

非数値文字を数値変数から削除します。logical true または false として指定します。

データ型: logical

出力引数

すべて折りたたむ

指定されたファイルのインポート オプション。SpreadsheetImportOptions オブジェクトまたは DelimitedTextImportOptions オブジェクトとして返されます。オプション オブジェクトのタイプは、指定したファイルの種類によって決まります。テキスト ファイル (.txt.dat または .csv) の場合、関数 detectImportOptionsDelimitedTextImportOptions オブジェクトまたは FixedWidthImportOptions オブジェクトを返します。スプレッドシート ファイル (.xls.xlsb.xlsm.xlsx.xltm.xltx または .ods) の場合、関数 detectImportOptionsSpreadsheetImportOptions オブジェクトを返します。

関数 detectImportOptions は、指定されたファイルの内容に基づいて、自動的にこれらのパラメーターを検出して設定します。

スプレッドシート ファイルの場合テキスト ファイルの場合
VariableNames (ある場合)VariableNames (ある場合)
VariableTypesVariableTypes
DataRangeDataLine
VariableNamesRangeVariableNamesLine
 Delimiter
 LeadingDelimitersRule (スペースが区切り記号の場合)
 ConsecutiveDelimitersRule (スペースが区切り記号の場合)
 PartialFieldRule (固定幅のファイルの場合)

R2016b で導入