ドキュメンテーション

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

summary

table、timetable または categorical 配列の概要の表示

構文

summary(T)
s = summary(T)
summary(A)
summary(A,dim)

説明

summary(T) は、table または timetable T の概要を表示します。

  • T が table の場合、table の概要には、T.Properties.Description からの説明に続いて table 変数の概要が表示されます。

  • T が timetable の場合、timetable の概要には、T.Properties.Description からの説明と行時間の概要に続いて timetable 変数の概要が表示されます。

s = summary(T) は、入力 table または timetable の概要が含まれる構造体 s を返します。s の各フィールドはそれ自体が構造体であり、T の対応する変数の値がまとめられています。T が timetable の場合、sT の行時間の概要のフィールドをもちます。

summary(A) は、categorical 配列 A の概要を表示します。

  • A がベクトルの場合、summary(A) はカテゴリ名と各カテゴリの要素数 (カテゴリ カウント) を表示します。また、未定義の要素の数も表示します。

  • A が行列の場合、summary は、A の列をベクトルとして取り扱い、A の各列のカテゴリ カウントを表示します。

  • A が多次元配列の場合、summary は、サイズが 1 でない最初の配列次元に沿って機能します。

summary(A,dim) は、categorical 配列 A の次元 dim に沿ったカテゴリ カウントを表示します。

たとえば、summary(A,2) を使用して、categorical 配列の各行のカウントを表示できます。

すべて折りたたむ

テーブルを作成します。

load patients
BloodPressure = [Systolic Diastolic];
T = table(Gender,Age,Smoker,BloodPressure,'RowNames',LastName);

テーブル T に説明と単位を追加します。table 全体、および個々の変数の説明を追加できます。

T.Properties.Description = 'Simulated patient data';
T.Properties.VariableUnits =  {''  'Yrs' ''  'mm Hg'};
T.Properties.VariableDescriptions{4} = 'Systolic/Diastolic';

テーブル T の概要を表示します。

format compact

summary(T)
Description:  Simulated patient data
Variables:
    Gender: 100x1 cell array of character vectors
    Age: 100x1 double
        Properties:
            Units:  Yrs
        Values:
            Min        25  
            Median     39  
            Max        50  
    Smoker: 100x1 logical
        Values:
            True        34   
            False       66   
    BloodPressure: 100x2 double
        Properties:
            Units:  mm Hg
            Description:  Systolic/Diastolic
        Values:
                      BloodPressure_1    BloodPressure_2
                      _______________    _______________
            Min             109                 68      
            Median          122               81.5      
            Max             138                 99      

summary は、変数 BloodPressure の各列の最小値、中央値および最大値を表示します。

小さい timetable を作成します。

Time = [seconds(1:5)]';
TT = timetable(Time,[98;97.5;97.9;98.1;97.9],[120;111;119;117;116],...
               'VariableNames',{'Reading1','Reading2'})
TT=5×2 timetable
    Time     Reading1    Reading2
    _____    ________    ________

    1 sec        98        120   
    2 sec      97.5        111   
    3 sec      97.9        119   
    4 sec      98.1        117   
    5 sec      97.9        116   

timetable の概要を表示します。summary は、行時間の概要に続いて変数の概要を表示します。規則的な timetable の場合、summary は行時間の間のタイム ステップのサイズも表示します。

summary(TT)
RowTimes:

    Time: 5x1 duration
        Values:

            Min          1 sec 
            Median       3 sec 
            Max          5 sec 
            TimeStep     1 sec 

Variables:

    Reading1: 5x1 double

        Values:

            Min          97.5   
            Median       97.9   
            Max          98.1   

    Reading2: 5x1 double

        Values:

            Min          111    
            Median       117    
            Max          120    

テーブルを作成します。table 変数に単位を追加します。その後、最初の数行を表示します。

load patients
BloodPressure = [Systolic Diastolic];
T = table(Gender,Age,Smoker,BloodPressure,'RowNames',LastName);
T.Properties.VariableUnits =  {''  'Years' ''  'mm Hg'};
head(T,3)
ans=3×4 table
                 Gender     Age    Smoker    BloodPressure
                ________    ___    ______    _____________

    Smith       'Male'      38     true       124     93  
    Johnson     'Male'      43     false      109     77  
    Williams    'Female'    38     false      125     83  

table の概要を返します。概要を構造体として返すには、関数 summary の使用に際して出力引数を指定します。

s = summary(T)
s = struct with fields:
           Gender: [1x1 struct]
              Age: [1x1 struct]
           Smoker: [1x1 struct]
    BloodPressure: [1x1 struct]

table 変数 Age の概要を表示します。T の各変数について、出力引数 s にはその概要が含まれるフィールドがあります。

s.Age
ans = struct with fields:
           Size: [100 1]
           Type: 'double'
    Description: ''
          Units: 'Years'
     Continuity: []
            Min: 25
         Median: 39
            Max: 50
     NumMissing: 0

NumMissing フィールドには、欠損値である要素の数が表示されます。ここでの場合、Age には NaN 値が含まれていないため、NumMissing は 0 です。summary には数値変数、duration 変数、datetime 変数、categorical 変数の NumMissing フィールドが含まれます。

table 内に含まれている年齢の最小値を表示します。概要の任意のフィールドに、名前を使ってアクセスすることができます。

s.Age.Min
ans = 25

table 変数 Smoker の概要を表示します。True フィールドと False フィールドから、喫煙者の数と非喫煙者の数を確認できます。table 変数の概要に含められる情報は、変数のデータ型によって異なります。

s.Smoker
ans = struct with fields:
           Size: [100 1]
           Type: 'logical'
    Description: ''
          Units: ''
     Continuity: []
           True: 34
          False: 66

timetable を作成します。

Time = datetime({'2015-12-18 08:00:00';'2015-12-18 10:00:00';'2015-12-18 12:00:00'});
Temp = [37.3;39.1;42.3];
Pressure = [30.1;30.03;29.9];
TT = timetable(Time,Temp,Pressure)
TT=3×2 timetable
            Time            Temp    Pressure
    ____________________    ____    ________

    18-Dec-2015 08:00:00    37.3      30.1  
    18-Dec-2015 10:00:00    39.1     30.03  
    18-Dec-2015 12:00:00    42.3      29.9  

timetable の概要を構造体として返します。

s = summary(TT)
s = struct with fields:
        Time: [1x1 struct]
        Temp: [1x1 struct]
    Pressure: [1x1 struct]

行時間の概要を表示します。TimeStep フィールドは、連続する行時間の間隔が 2 時間であることを示しています。NumMissing フィールドは、行時間のベクトルに欠損値 (NaT) がないことを示しています。

s.Time
ans = struct with fields:
          Size: [3 1]
          Type: 'datetime'
           Min: 18-Dec-2015 08:00:00
        Median: 18-Dec-2015 10:00:00
           Max: 18-Dec-2015 12:00:00
    NumMissing: 0
      TimeStep: 02:00:00

最後の行時間を変更して、行時間の時間間隔がそれぞれ異なるようにします。

TT.Time(3) = '2015-12-18 11:00:00';
TT
TT=3×2 timetable
            Time            Temp    Pressure
    ____________________    ____    ________

    18-Dec-2015 08:00:00    37.3      30.1  
    18-Dec-2015 10:00:00    39.1     30.03  
    18-Dec-2015 11:00:00    42.3      29.9  

更新した timetable の概要を返します。行時間の間のタイム ステップに違いがあるため、TimeStep フィールドは NaN になります。

s = summary(TT);
s.Time
ans = struct with fields:
          Size: [3 1]
          Type: 'datetime'
           Min: 18-Dec-2015 08:00:00
        Median: 18-Dec-2015 10:00:00
           Max: 18-Dec-2015 11:00:00
    NumMissing: 0
      TimeStep: NaN

R2018b より、カスタム プロパティを table と timetable に追加できるようになりました。カスタム プロパティを追加すると、table または timetable の概要にそれらのプロパティが含まれます。

最初に、table を作成し、その事前定義されているプロパティのいくつかに値を追加します。

load patients
BloodPressure = [Systolic Diastolic];
T = table(Gender,Age,Smoker,BloodPressure,'RowNames',LastName);
T.Properties.Description = 'Simulated patient data';
T.Properties.VariableUnits =  {''  'Yrs' ''  'mm Hg'};
T.Properties.VariableDescriptions{4} = 'Systolic/Diastolic';

関数 addprop を使用してカスタム プロパティを追加します。カスタム プロパティごとに 1 つの名前を指定します。また、各カスタム プロパティの値に、table または個々の table 変数に適用されるメタデータを保存するかどうを指定します。

T = addprop(T,{'SourceFile','DataOrigin'},{'table','variable'});

カスタム プロパティにメタデータ値を保存します。

T.Properties.CustomProperties.SourceFile = 'patients.mat';
T.Properties.CustomProperties.DataOrigin = {'census','census','self report','blood pressure reading'};

table の概要を表示します。T.Properties.Description は別として、関数 summary では、table 全体に適用されるプロパティは表示されません。そのため、T.Properties.CustomProperties.SourceFile の値は表示されません。ただし、summary では、table 変数に適用されるプロパティが表示されます。変数ごとに、summary では T.Properties.CustomProperties.DataOrigin からの対応する値が表示されます。

summary(T)
Description:  Simulated patient data
Variables:
    Gender: 100×1 cell array of character vectors
        Custom Properties:
            DataOrigin:  census
    Age: 100×1 double
        Properties:
            Units:  Yrs
        Custom Properties:
            DataOrigin:  census
        Values:
            Min        25  
            Median     39  
            Max        50  
    Smoker: 100×1 logical
        Custom Properties:
            DataOrigin:  self report
        Values:
            True        34   
            False       66   
    BloodPressure: 100×2 double
        Properties:
            Units:  mm Hg
            Description:  Systolic/Diastolic
        Custom Properties:
            DataOrigin:  blood pressure reading
        Values:
                      BloodPressure_1    BloodPressure_2
                      _______________    _______________
            Min             109                 68      
            Median          122               81.5      
            Max             138                 99      

概要を構造体として返します。各フィールドには table 変数の 1 つに対応する構造体が含まれています。

s = summary(T)
s = struct with fields:
           Gender: [1×1 struct]
              Age: [1×1 struct]
           Smoker: [1×1 struct]
    BloodPressure: [1×1 struct]

構造体 s.Age には変数 Age の概要が保存されます。

s.Age
ans = struct with fields:
                Size: [100 1]
                Type: 'double'
         Description: ''
               Units: 'Yrs'
          Continuity: []
                 Min: 25
              Median: 39
                 Max: 50
          NumMissing: 0
    CustomProperties: [1×1 struct]

s.Age.CustomProperties 構造体には、T.Properties.CustomProperties.DataOrigin プロパティからの対応する値が保存されます。

s.Age.CustomProperties
ans = struct with fields:

    DataOrigin: {'census'}

1 行 5 列のカテゴリカル ベクトルを作成します。

A = categorical({'plane' 'car' 'train' 'car' 'plane'})
A = 1x5 categorical array
     plane      car      train      car      plane 

A には、carplanetrain の 3 つのカテゴリがあります。

A の概要を表示します。

summary(A)
     car      plane      train 
       2          2          1 

carA の 2 つの要素に出現し、plane は 2 つの要素に出現し、train は 1 つの要素に出現します。

A は行ベクトルであるため、summary は各カテゴリの出現を水平方向に表示します。

数値配列から 4 行 2 列の categorical 配列 A を作成します。

X = [1 3; 2 1; 3 1; 4 2];
valueset = 1:3;
catnames = {'red','green','blue'};

A = categorical(X,valueset,catnames)
A = 4x2 categorical array
     red              blue  
     green            red   
     blue             red   
     <undefined>      green 

A には、redgreenblue の 3 つのカテゴリがあります。値 4 は、関数 categorical への入力 valueset には含まれていませんでした。そのため、対応する要素 A(4,1) は対応するカテゴリをもたず、未定義になります。

A の概要を表示します。

summary(A)
     red              1      2 
     green            1      1 
     blue             1      1 
     <undefined>      1      0 

red は、A の最初の列で 1 回出現し、2 番目の列で 2 回出現します。

green は、A の最初の列と 2 番目の列でそれぞれ 1 回出現します。

blue は、A の最初の列と 2 番目の列でそれぞれ 1 回出現します。

A には、未定義の要素が 1 つしか含まれていません。これは最初の列に出現します。

数値配列から 3 行 2 列の categorical 配列 A を作成します。

A = categorical([1 3; 2 1; 3 1],1:3,{'red','green','blue'})
A = 3x2 categorical array
     red        blue 
     green      red  
     blue       red  

A には、redgreenblue の 3 つのカテゴリがあります。

A の 2 番目の次元に沿った概要を表示します。

summary(A,2)
     red      green      blue 
       1          0         1 
       1          1         0 
       1          0         1 

red は、A の最初の行、2 番目の行、3 番目の行でそれぞれ 1 回出現します。

green は 1 つの要素にしか出現しません。出現するのは A の 2 番目の行です。

blue は、A の最初の行と 3 番目の行で 1 回ずつ出現します。

入力引数

すべて折りたたむ

入力テーブル。table または timetable として指定します。

categorical 配列。ベクトル、行列または多次元配列として指定します。

動作する対象の A の次元。正の整数のスカラーとして指定します。値が指定されていない場合、既定値はサイズが 1 ではない最初の配列次元です。

2 次元の categorical 配列 A について考えます。

dim = 1 の場合、summary(A,dim)A の各列のカテゴリ カウントを表示します。

dim = 2 の場合、summary(A,dim)A の各行のカテゴリ カウントを返します。

dimndims(A) より大きい場合、summary(A) は、各カテゴリについて A と同じサイズの配列を返します。summary は、対応するカテゴリの要素については 1 を返し、それ以外については 0 を返します。

出力引数

すべて折りたたむ

table 変数または timetable 変数の概要。スカラー構造体として返されます。入力 T の変数 T.VarName それぞれについて、出力構造体 s にはその変数の概要をもつフィールド s.VarName が含まれています。

データ型ごとに、s.VarName には以下に示すフィールドがあります。これらのフィールドにはドット インデックスを使ってアクセスできます。たとえば、s.VarName.Size は、VarName という名前の table 変数のサイズを返します。

table 変数または timetable 変数の型

変数の概要のフィールド

説明

数値、datetime、または duration

Size

変数のサイズ。数値配列として保存されます

Type

変数の型。文字ベクトルとして保存されます

Description

変数の説明。文字ベクトルとして保存されます

Units

変数の単位。文字ベクトルとして保存されます

Min

最小値

Median

中央値

Max

最大値

NumMissing

欠損値 (NaN または NaT) の数

CustomProperties (カスタム プロパティがない場合は省略される)

変数に関連付けられたカスタム プロパティの名前と値。構造体として保存されます。

論理値

Size

変数のサイズ。数値配列として保存されます

Type

変数の型。文字ベクトルとして保存されます

Description

変数の説明。文字ベクトルとして保存されます

Units

変数の単位。文字ベクトルとして保存されます

True

true 値の数

False

false 値の数

CustomProperties (カスタム プロパティがない場合は省略される)

変数に関連付けられたカスタム プロパティの名前と値。構造体として保存されます。

categorical

Size

変数のサイズ。数値配列として保存されます

Type

変数の型。文字ベクトルとして保存されます

Description

変数の説明。文字ベクトルとして保存されます

Units

変数の単位。文字ベクトルとして保存されます

Categories

カテゴリ。文字ベクトルの cell 配列として保存されます

Counts

各カテゴリの要素数。数値配列として保存されます

NumMissing

欠損値 (<undefined>) の数

CustomProperties (カスタム プロパティがない場合は省略される)

変数に関連付けられたカスタム プロパティの名前と値。構造体として保存されます。

その他

Size

変数のサイズ。数値配列として保存されます

Type

変数の型。文字ベクトルとして保存されます

Description

変数の説明。文字ベクトルとして保存されます

Units

変数の単位。文字ベクトルとして保存されます

CustomProperties (カスタム プロパティがない場合は省略される)

変数に関連付けられたカスタム プロパティの名前と値。構造体として保存されます。

T が timetable の場合、s は行時間の概要のフィールドをもちます。timetable の行時間に限り、概要には TimeStep フィールドが含まれます。行時間が固定タイム ステップで単調に増加または減少する場合、TimeStep は数値をもちます。行時間が不規則の場合、TimeStepNaN となります。

timetable の行時間の概要のフィールド

フィールドの説明

Size

行時間のベクトルのサイズ。数値配列として保存されます

Type

データ型。文字ベクトルとして保存されます

Min

最小値

Median

中央値

Max

最大値

NumMissing

欠損値 (NaT または NaN) の数

TimeStep

連続する行時間の間のタイム ステップ (不規則の場合は NaN)

詳細

すべて折りたたむ

テーブルの概要

テーブルの概要には、T.Properties.Description からのテーブルの説明が表示され、その後に T の変数に関する情報が表示されます。

概要には、変数に関する以下の情報が含まれます。

  • 名前: サイズとデータ型 — T.Properties.VariableNames からの変数名、変数のサイズ、および変数のデータ型。

  • 単位 — T.Properties.VariableUnits からの変数の単位。

  • 説明 — T.Properties.VariableDescriptions からの変数の説明。

  • カスタム プロパティ — T.Properties.CustomProperties からの変数に適用されるカスタム プロパティの名前、および対応する値。カスタム プロパティがない場合、このセクションは省略されます。

  • 値 — 数値変数、論理変数、categorical 変数、datetime 変数、または duration 変数の場合にのみ含まれます。

    • 数値変数、datetime 変数、または duration 変数 — 最小値、中央値、および最大値。また、欠損値 (NaN または NaT) の数が 0 より大きい場合は、その数も含まれます。

    • 論理変数 — true である値の数と false である値の数。

    • categorical 変数 — 各カテゴリの要素の数。また、未定義の要素の数が 0 より大きい場合は、その数も含まれます。

T が timetable の場合、概要には行時間のベクトルについての同じ情報が含まれます。

拡張機能

R2013b で導入