DataSet Object Fields

From Eigenvector Research Documentation Wiki
Revision as of 16:14, 10 October 2008 by imported>Jeremy (New page: The following is a list of the <tt>DataSet</tt> object properties (fields). The values in all fields can be assigned or retrieved using direct assignments (See SUBSASGN and SUBSREF in Sect...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The following is a list of the DataSet object properties (fields). The values in all fields can be assigned or retrieved using direct assignments (See SUBSASGN and SUBSREF in Section 3) or through the SET and GET methods (also described in Section 3) although direct assignments are the preferred of those two methods. For a walk-through example of how to build a DataSet object, see Section 4.

.name

char array (row vector)

This is usually the original variable name but can be set by the user. For example:

h = dataset(randn(5));
h.name = 'mydata';
h.name
ans =
   mydata

where ans is a 1x6 character array.

.type

string with one of the following values

'data', 'image', and 'batch'. See field '.data' for more information on these data types.

When .type = 'image', three additional fields are available in the DataSet: .imagemode, .imagesize, .imagedata, and .imageinclude. Each of these fields is described below.

.author

char array (row vector)

Used to assign authorship to a DataSet.

h.author = 'Joan Smith / Big Name Pharma';

.date

double array (1x6)

Six-element date/time stamp [year, month, day, hour, minute, second] indicating when the DataSet was created.

.moddate

double array (1x6)

Six-element date/time stamp indicating when the DataSet was last modified.