htmlImportOptions

HTML ファイルのインポートオプションオブジェクト

R2021b 以降

説明

HTMLImportOptions オブジェクトでは、MATLAB^® が構造化された表形式データを HTML ファイルからインポートする方法を指定できます。オブジェクトには、エラーおよび欠損データの処理を含む、データのインポートプロセスを制御するプロパティが含まれています。

作成

HTMLImportOptions オブジェクトは、関数 htmlImportOptions (ここで説明します) または関数 detectImportOptions により作成できます。

htmlImportOptions は、インポートの要件に基づいてインポートプロパティを定義する場合に使用します。
detectImportOptions は、filename で指定した HTML ファイルの内容に基づいてインポートプロパティを検出して入力する場合に使用します。
```
opts = detectImportOptions(filename)
```

構文

opts = htmlImportOptions

opts = htmlImportOptions('NumVariables',numVars)

opts = htmlImportOptions(___,Name,Value)

説明

opts = htmlImportOptions は、1 つの変数をもつ HTMLImportOptions オブジェクトを作成します。

opts = htmlImportOptions('NumVariables',numVars) は、numVars で指定した数の変数をもつオブジェクトを作成します。

opts = htmlImportOptions(___,Name,Value) は、1 つ以上の名前と値の引数を使用して、HTMLImportOptions オブジェクトの追加プロパティを指定します。

例

入力引数

すべて展開する

`numVars` — 変数の数
正のスカラー整数

変数の数。正のスカラー整数として指定します。

プロパティ

すべて展開する

変数プロパティ

`VariableNames` — 変数名
文字ベクトルの cell 配列 | string 配列

変数名。文字ベクトルの cell 配列または string 配列として指定します。VariableNames プロパティには、変数のインポート時に使用する名前が含まれます。

データに N 個の変数が含まれているが変数名が指定されない場合、VariableNames プロパティには {'Var1','Var2',...,'VarN'} が含まれます。

スペースおよび非 ASCII 文字を含む変数名など、無効な MATLAB 識別子を変数名としてサポートするには、VariableNamingRule の値を 'preserve' に設定します。

例: opts.VariableNames は、現在の (検出された) 変数名を返します。

例: opts.VariableNames(3) = {'Height'} は 3 番目の変数の名前を Height に変更します。

データ型: char | string | cell

`VariableNamingRule` — 変数名を保持するかどうかのフラグ
`"preserve"` (既定値) | `"modify"`

変数名を保持するかどうかのフラグ。"modify" または "preserve" として指定します。

"modify" — 無効な変数名 (関数 isvarname で判定) を、有効な MATLAB 識別子に変換。
"preserve" — スペースや非 ASCII 文字を含む変数名など、有効な MATLAB 識別子ではない変数名を保持。

R2019b 以降、変数名と行名には、スペースや非 ASCII 文字など任意の文字を含めることができます。また、英字だけでなく任意の文字で始めることができます。変数名と行名は、有効な MATLAB 識別子 (関数 isvarname で判定) である必要はありません。これらの変数名と行名を保持するには、VariableNamingRule の値を "preserve" に設定します。VariableNamingRule の値を "modify" から "preserve" に変更すると、変数名が更新されなくなります。

`VariableTypes` — 変数のデータ型
文字ベクトルの cell 配列 | string 配列

変数のデータ型。一連の有効なデータ型の名前を含む文字ベクトルの cell 配列または string 配列として指定します。VariableTypes プロパティは、変数のインポート時に使用するデータ型を指定します。

VariableTypes プロパティを更新するには、関数 setvartype を使用します。

例: opts.VariableTypes は、現在の変数のデータ型を返します。

例: opts = setvartype(opts,'Height',{'double'}) は、変数 Height のデータ型を double に変更します。

`SelectedVariableNames` — インポートする変数のサブセット
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列 | 数値インデックスの配列

インポートする変数のサブセット。文字ベクトル、string スカラー、文字ベクトルの cell 配列、string 配列、または数値インデックスの配列として指定します。

SelectedVariableNames は VariableNames プロパティに含まれる名前のサブセットでなければなりません。既定では、SelectedVariableNames には VariableNames プロパティからのすべての変数名が含まれます。つまり、すべての変数がインポートされることを意味します。

特定の変数のみをインポートするには、SelectedVariableNames プロパティを使用します。SelectedVariableNames プロパティを使用して変数のサブセットを指定し、readtable を使用してそのサブセットのみをインポートします。

例: opts.SelectedVariableNames = {'Height','LastName'} は、インポート操作のために 2 つの変数 Height と LastName のみを選択します。

例: opts.SelectedVariableNames = [1 5] は、インポート操作のために最初の変数と 5 番目の変数の 2 つの変数のみを選択します。

例: T = readtable(filename,opts) は、opts オブジェクトの SelectedVariableNames プロパティで指定された変数のみを含む table を返します。

`VariableOptions` — 型固有の変数のインポートオプション
変数インポートオプションオブジェクトの配列

型固有の変数のインポートオプション。変数インポートオプションオブジェクトの配列として返されます。配列には、VariableNames プロパティで指定された各変数に対応するオブジェクトが含まれます。配列の各オブジェクトには、特定のデータ型でのデータのインポートをサポートするプロパティが含まれます。

変数オプションは、数値、テキスト、logical、datetime または categorical のデータ型をサポートします。

変数の現在の (または検出された) オプションをクエリするには、関数 getvaropts を使用します。

変数にオプションを設定してカスタマイズするには、関数 setvaropts を使用します。

例: opts.VariableOptions は、データの各変数に対応する VariableImportOptions オブジェクトの集合を返します。

例: getvaropts(opts,'Height') は、変数 Height の VariableImportOptions オブジェクトを返します。

例: opts = setvaropts(opts,'Height','FillValue',0) は変数 Height の FillValue プロパティを 0 に設定します。

位置プロパティ

`TableSelector` — table データの XPath 式
文字ベクトル | string スカラー

table データの XPath 式。文字ベクトルまたは string スカラーとして指定します。読み取り関数は、これを使用して出力 table のデータを選択します。TableSelector には有効な XPath Version 1.0 の式を指定しなければなりません。

次の表に、HTML ファイル内の table を選択するための XPath 式の例をいくつか示します。

説明	`TableSelector`
テキスト "Cash dividends" を含む table	`"//TABLE[contains(.,'Cash dividends')]"`
行数が 10 を超える 2 番目の table	`"//TABLE[count(TR)>10][2]"`
ヘッダー cell が "Description" と完全に一致する table	`"//TABLE[.//TH='Description']"`
表題に "Report" が含まれている table	`"//TABLE[contains(CAPTION,'Report')]"`
セクションヘッダー "Summary" の後に最初にある table	`"H1[.='Summary']/following-sibling::TABLE[1]"`
`id` 属性が `'income'` と一致する table	`"//TABLE[@id='income']"`

例: 'TableSelector',"//TABLE[contains(.,'Cash dividends')]"

`DataRows` — データの場所
正のスカラー整数 | 正のスカラー整数の配列

データの場所。正のスカラー整数または正のスカラー整数の N- 行 -2 列の配列として指定します。これらの形式の 1 つを使用して DataRows を指定します。

次として指定	説明
`n`	データが含まれる "最初の行" を指定します。`n` を使用して値を指定すると、`DataRows` プロパティの値が `[n inf]` に設定されます。インポート関数は `n` とファイル終端の間のすべての行を読み取ります。 `n` はゼロより大きい正の整数にしなければなりません。
`[n1 n2]`	データが含まれる "行の範囲" を指定します。`n1` はデータが含まれる最初の行で、`n2` はデータが含まれる最後の行です。配列 `[n1 n2]` 内の値は非ゼロの正の整数で、`n2` は `n1` より大きくなければなりません。
`[n1 n2; n3 n4;...]`	"複数の行範囲" を指定して、`N` の異なる行範囲を含む `N` 行 `2` 列の配列で読み取ります。有効な複数の行範囲の配列は、次でなければなりません。行の範囲は昇順で指定する。すなわち、配列で指定された最初の行範囲は、他の行範囲より、ファイル内で先に出現する。オーバーラップしない行範囲のみを含む。複数の行範囲を指定するときは、配列内で最後の行範囲の末尾を指定する場合にのみ `Inf` を使用します。たとえば、`[1 3; 5 6; 8 Inf]` とします。

次として指定

説明

n

データが含まれる "最初の行" を指定します。n を使用して値を指定すると、DataRows プロパティの値が [n inf] に設定されます。インポート関数は n とファイル終端の間のすべての行を読み取ります。

n はゼロより大きい正の整数にしなければなりません。

[n1 n2]

データが含まれる "行の範囲" を指定します。n1 はデータが含まれる最初の行で、n2 はデータが含まれる最後の行です。

配列 [n1 n2] 内の値は非ゼロの正の整数で、n2 は n1 より大きくなければなりません。

[n1 n2; n3 n4;...]

"複数の行範囲" を指定して、N の異なる行範囲を含む N 行 2 列の配列で読み取ります。

有効な複数の行範囲の配列は、次でなければなりません。

行の範囲は昇順で指定する。すなわち、配列で指定された最初の行範囲は、他の行範囲より、ファイル内で先に出現する。
オーバーラップしない行範囲のみを含む。

複数の行範囲を指定するときは、配列内で最後の行範囲の末尾を指定する場合にのみ Inf を使用します。たとえば、[1 3; 5 6; 8 Inf] とします。

例: opts.DataRows = 5 は、DataRows プロパティを [5 inf] の値に設定します。行 5 からファイル終端までのデータ行をすべて読み取ります。

例: opts.DataRows = [2 6] は、行 2 から行 6 までを読み取るプロパティを設定します。

例: opts.DataRows = [1 3; 5 6; 8 inf] は 1、2、3、5、6 の各行と 8 からファイル終端までのすべての行を読み取るプロパティを設定します。

`RowNamesColumn` — 行名の位置
`0` (既定値) | 正のスカラー整数

行名の位置。正のスカラー整数として指定します。RowNamesColumn プロパティは行名を含む列の位置を指定します。

RowNamesColumn を 0 として指定した場合は、行名をインポートしません。それ以外の場合、行名を指定された列からインポートします。

例: opts.RowNamesColumn = 2;

`VariableNamesRow` — 変数の名前を含む行
`0` (既定値) | 非負の整数

変数の名前を含む行。非負の整数として指定します。VariableNamesRow プロパティは変数名がある位置の行番号を指定します。

VariableNamesRow が 0 の場合は、変数名をインポートしません。それ以外の場合、指定された行から変数名をインポートします。

例: opts.VariableNamesRow = 6;

`VariableUnitsRow` — 変数の単位を含む行
`0` (既定値) | 非負の整数

変数の単位を含む行。非負の整数として指定します。

VariableUnitsRow が 0 の場合、変数の単位はインポートされません。それ以外の場合、指定した行から変数の単位がインポートされます。

`VariableDescriptionsRow` — 変数の説明を含む行
`0` (既定値) | 非負の整数

変数の説明を含む行。非負の整数として指定します。

VariableDescriptionsRow が 0 の場合、変数の説明はインポートされません。それ以外の場合、指定した行から変数の説明がインポートされます。

置換ルール

`MissingRule` — 欠損データを管理する方法
`'fill'` (既定値) | `'error'` | `'omitrow'` | `'omitvar'`

欠損データを管理する方法。次の表のいずれかの値として指定します。

欠損ルール	動作
`'fill'`	欠損データを `FillValue` プロパティの内容に置き換えます。 `FillValue` プロパティは、インポートされる変数の `VariableImportOptions` オブジェクトで指定されます。`FillValue` プロパティへのアクセスの詳細については、`setvaropts` を参照してください。
`'error'`	インポートを停止し、欠損しているレコードとフィールドを示すエラーメッセージを表示します。
`'omitrow'`	欠損データを含む行を除外します。
`'omitvar'`	欠損データを含む変数を除外します。

例: opts.MissingRule = 'omitrow';

データ型: char | string

`EmptyRowRule` — 空行を処理する手続き
`"skip"` (既定値) | `"read"` | `"error"`

データ内の空行を処理する手続き。"skip"、"read"、または "error" として指定します。インポート関数は空白を空として解釈します。

空行のルール	動作
`"skip"`	空行をスキップします。
`"read"`	空行をインポートします。インポート関数は、`VariableOptions`、`MissingRule`、およびその他の関連するプロパティに指定された値を使用して、空の行を解析します。
`"error"`	エラーメッセージを表示し、インポート操作を中止します。

`ImportErrorRule` — インポートエラーを処理する方法
`'fill'` (既定値) | `'error'` | `'omitrow'` | `'omitvar'`

インポートエラーを処理する方法。次の表のいずれかの値として指定します。

インポートエラールール	動作
`'fill'`	エラーが発生したデータを `FillValue` プロパティの内容に置き換えます。 `FillValue` プロパティは、インポートされる変数の `VariableImportOptions` オブジェクトで指定されます。`FillValue` プロパティへのアクセスの詳細については、`setvaropts` を参照してください。
`'error'`	インポートを停止し、エラーの原因となるレコードとフィールドを示すエラーメッセージを表示します。
`'omitrow'`	エラーが発生した行を除外します。
`'omitvar'`	エラーが発生した変数を除外します。

例: opts.ImportErrorRule = 'omitvar';

データ型: char | string

`ExtraColumnsRule` — 余分な列を処理する方法
`'addvars'` | `'ignore'` | `'wrap'` | `'error'`

データ内の余分な列を処理する方法。次の表のいずれかの値として指定します。

余分な列のルール	動作
`'addvars'`	余分な列をインポートするには、新しい変数を作成します。余分な列が `N` 列ある場合、新しい変数を `'ExtraVar1', 'ExtraVar2',..., 'ExtraVarN'` としてインポートします。データの余分な列は `VariableTypes` が `char` であるものとしてインポートされます。
`'ignore'`	データの余分な列を無視します。
`'wrap'`	データの余分な列を新しいレコードにラップします。このアクションで変数の数は変わりません。
`'error'`	エラーメッセージを表示し、インポート操作を中止します。

データ型: char | string

`MergedCellColumnRule` — 列がマージされたセルの処理方法
`"placeleft"` (既定値) | `"placeright"` | `"duplicate"` | `"omitrow"` | `"error"`

列がマージされたセルの処理方法。次の表のいずれかの値として指定します。

インポートルール	動作
`"placeleft"`	一番左のセルにデータを配置し、残りのセルは `FillValue` プロパティの内容で埋めます。 `FillValue` プロパティは、インポートされる変数の `VariableImportOptions` オブジェクトで指定されます。`FillValue` プロパティへのアクセスの詳細については、`getvaropts` を参照してください。
`"placeright"`	一番右のセルにデータを配置し、残りのセルは `FillValue` プロパティの内容で埋めます。 `FillValue` プロパティは、インポートされる変数の `VariableImportOptions` オブジェクトで指定されます。`FillValue` プロパティへのアクセスの詳細については、`getvaropts` を参照してください。
`"duplicate"`	すべてのセルにデータを複製します。
`"omitrow"`	マージされたセルがある行を除外します。
`"error"`	エラーメッセージを表示し、インポート操作を中止します。

例: "MergedCellColumnRule","placeright"

`MergedCellRowRule` — 行がマージされたセルの処理方法
`"placetop"` (既定値) | `"placebottom"` | `"duplicate"` | `"omitvar"` | `"error"`

行がマージされたセルの処理方法。次の表のいずれかの値として指定します。

インポートルール	動作
`"placetop"`	一番上のセルにデータを配置し、残りのセルは `FillValue` プロパティの内容で埋めます。 `FillValue` プロパティは、インポートされる変数の `VariableImportOptions` オブジェクトで指定されます。`FillValue` プロパティへのアクセスの詳細については、`getvaropts` を参照してください。
`"placebottom"`	一番下のセルにデータを配置し、残りのセルは `FillValue` プロパティの内容で埋めます。 `FillValue` プロパティは、インポートされる変数の `VariableImportOptions` オブジェクトで指定されます。`FillValue` プロパティへのアクセスの詳細については、`getvaropts` を参照してください。
`"duplicate"`	すべてのセルにデータを複製します。
`"omitvar"`	行がマージされた変数を除外します。
`"error"`	エラーメッセージを表示し、インポート操作を中止します。

例: "MergedCellRowRule","duplicate"

オブジェクト関数

例

すべて折りたたむ

HTML ファイルのインポートオプションの作成

ライブスクリプトを開く

HTML ファイルのインポートオプションを作成し、インポートする table を指定してから、データを読み取ります。

HTMLDocumentImportOptions オブジェクトを作成します。XPath クエリ "//TABLE[contains(.,'readtable')]" を使用して、"readtable" という単語を含む最初の table を読み取ります。

opts = htmlImportOptions('TableSelector',"//TABLE[contains(.,'readtable')]")

opts = 
  HTMLImportOptions with properties:

   Replacement Properties:
                MissingRule: "fill"
            ImportErrorRule: "fill"
               EmptyRowRule: "skip"
       MergedCellColumnRule: "placeleft"
          MergedCellRowRule: "placetop"
           ExtraColumnsRule: "addvars"

   Variable Import Properties: Set types by name using setvartype
              VariableNames: "Var1"
              VariableTypes: "char"
      SelectedVariableNames: "Var1"
            VariableOptions: Show all 1 VariableOptions 
	Access VariableOptions sub-properties using setvaropts/getvaropts
         VariableNamingRule: "preserve"

   Location Properties:
              TableSelector: "//TABLE[contains(.,'readtable')]"
                   DataRows: [1 Inf]
           VariableNamesRow: 0
           VariableUnitsRow: 0
    VariableDescriptionsRow: 0
             RowNamesColumn: 0

関数 readtable でオプションオブジェクトを使用して、URL https://www.mathworks.com/help/matlab/text-files.html から table を読み取ります。

url = "https://www.mathworks.com/help/matlab/text-files.html";
T = readtable(url,opts)

T=4×2 table
           Var1                     ExtraVar1           
    __________________    ______________________________

    {'readtable'     }    {'Create table from file'    }
    {'writetable'    }    {'Write table to file'       }
    {'readtimetable' }    {'Create timetable from file'}
    {'writetimetable'}    {'Write timetable to file'   }

バージョン履歴

R2021b で導入

参考

detectImportOptions | readtable | readtimetable

htmlImportOptions

説明

作成

構文

説明

入力引数

numVars — 変数の数 正のスカラー整数

プロパティ

変数プロパティ

VariableNames — 変数名 文字ベクトルの cell 配列 | string 配列

VariableNamingRule — 変数名を保持するかどうかのフラグ "preserve" (既定値) | "modify"

VariableTypes — 変数のデータ型 文字ベクトルの cell 配列 | string 配列

SelectedVariableNames — インポートする変数のサブセット 文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列 | 数値インデックスの配列

VariableOptions — 型固有の変数のインポート オプション 変数インポート オプション オブジェクトの配列

位置プロパティ

TableSelector — table データの XPath 式 文字ベクトル | string スカラー

DataRows — データの場所 正のスカラー整数 | 正のスカラー整数の配列

RowNamesColumn — 行名の位置 0 (既定値) | 正のスカラー整数

VariableNamesRow — 変数の名前を含む行 0 (既定値) | 非負の整数

VariableUnitsRow — 変数の単位を含む行 0 (既定値) | 非負の整数

VariableDescriptionsRow — 変数の説明を含む行 0 (既定値) | 非負の整数

置換ルール

MissingRule — 欠損データを管理する方法 'fill' (既定値) | 'error' | 'omitrow' | 'omitvar'

EmptyRowRule — 空行を処理する手続き "skip" (既定値) | "read" | "error"

ImportErrorRule — インポート エラーを処理する方法 'fill' (既定値) | 'error' | 'omitrow' | 'omitvar'

ExtraColumnsRule — 余分な列を処理する方法 'addvars' | 'ignore' | 'wrap' | 'error'

MergedCellColumnRule — 列がマージされたセルの処理方法 "placeleft" (既定値) | "placeright" | "duplicate" | "omitrow" | "error"

MergedCellRowRule — 行がマージされたセルの処理方法 "placetop" (既定値) | "placebottom" | "duplicate" | "omitvar" | "error"

オブジェクト関数

例

HTML ファイルのインポート オプションの作成

バージョン履歴

参考

トピック

`numVars` — 変数の数
正のスカラー整数

`VariableNames` — 変数名
文字ベクトルの cell 配列 | string 配列

`VariableNamingRule` — 変数名を保持するかどうかのフラグ
`"preserve"` (既定値) | `"modify"`

`VariableTypes` — 変数のデータ型
文字ベクトルの cell 配列 | string 配列

`SelectedVariableNames` — インポートする変数のサブセット
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列 | 数値インデックスの配列

`VariableOptions` — 型固有の変数のインポートオプション
変数インポートオプションオブジェクトの配列

`TableSelector` — table データの XPath 式
文字ベクトル | string スカラー

`DataRows` — データの場所
正のスカラー整数 | 正のスカラー整数の配列

`RowNamesColumn` — 行名の位置
`0` (既定値) | 正のスカラー整数

`VariableNamesRow` — 変数の名前を含む行
`0` (既定値) | 非負の整数

`VariableUnitsRow` — 変数の単位を含む行
`0` (既定値) | 非負の整数

`VariableDescriptionsRow` — 変数の説明を含む行
`0` (既定値) | 非負の整数

`MissingRule` — 欠損データを管理する方法
`'fill'` (既定値) | `'error'` | `'omitrow'` | `'omitvar'`

`EmptyRowRule` — 空行を処理する手続き
`"skip"` (既定値) | `"read"` | `"error"`

`ImportErrorRule` — インポートエラーを処理する方法
`'fill'` (既定値) | `'error'` | `'omitrow'` | `'omitvar'`

`ExtraColumnsRule` — 余分な列を処理する方法
`'addvars'` | `'ignore'` | `'wrap'` | `'error'`

`MergedCellColumnRule` — 列がマージされたセルの処理方法
`"placeleft"` (既定値) | `"placeright"` | `"duplicate"` | `"omitrow"` | `"error"`

`MergedCellRowRule` — 行がマージされたセルの処理方法
`"placetop"` (既定値) | `"placebottom"` | `"duplicate"` | `"omitvar"` | `"error"`

HTML ファイルのインポートオプションの作成