groupedData

Table-like collection of data and metadata for fitting in SimBiology

Description

The groupedData object is the required data format to store data needed for fitting using fitproblem, sbiofit, and sbiofitmixed. It is a table-like object with a few differences.

• The groupedData object has two additional properties to identify the independent variable and an optional grouping variable.

• The groupedData object has additional methods that let you create doses and variants from data set and convert a groupedData object to a table.

• groupedData.Properties is a structure.

Creation

Syntax

grpData = groupedData

grpData = groupedData(tbl)

grpData = groupedData(tbl,groupVarName)

grpData = groupedData(tbl,groupVarName,independentVarName)

Description

grpData = groupedData creates an empty groupedData object.

grpData = groupedData(tbl) creates a groupedData object by copying a table or dataset object tbl. The GroupVariableName and IndependentVariableName properties of the grpData object are implicitly determined by looking for the first case-insensitive match to a list of variable names of tbl (tbl.Properties.VariableNames). For the grouping variable, the list of names is ID, Group, I, and Run. For the independent variable, the list of names is Time, T, and IDV. If there are no matches, GroupVariableName and IndependentVariableName are set to empty character vectors ''.

grpData = groupedData(tbl,groupVarName) sets the GroupVariableName property of the grpData object to groupVarName. The IndependentVariableName property is implicitly set as in the previous syntax.

grpData = groupedData(tbl,groupVarName,independentVarName) additionally sets the IndependentVariableName property of the grpData object to independentVarName.

Input Arguments

tbl — Data

table | dataset

Data, specified as a table or dataset.

groupVarName — Grouping variable name

character vector | string

Grouping variable name, specified as a character vector or string. An empty character vector '' or string "" indicates that there is no group variable.

independentVarName — Independent variable name

character vector | string

Independent variable name, specified as a character vector or string. An empty character vector '' or string "" indicates that there is no independent variable.

Output Arguments

grpData — Grouped data

groupedData object

Grouped data, returned as a groupedData object.

Properties

The groupedData object supports all metadata properties of table. Access these properties using the syntax grpData.Properties.PropertyName, where PropertyName is the name of a property. For example, you can access the names of the variables in grpData using the syntax grpData.Properties.VariableNames. The groupedData object provides the following additional metadata properties.

GroupVariableName — Name of grouping variable

character vector

Name of the grouping variable that indicates the groups in the data, specified as a character vector. To indicate that there are no groups (or just one group), set the property to the empty character vector ''.

Example: 'ID'

IndependentVariableName — Name of independent variable

'' (default) | character vector

Name of the independent variable in the data such as time, specified as a character vector.

Example: 'TIME'

Object Functions

The groupedData object supports many functions of table. However, it does not support the math operations that the table supports, such as +, -, / , min, max, mean, and so on. To see a list of math operations that the table supports, see here. The groupedData object has the following additional functions.

createDoses	Create dose objects from groupedData object
createVariants	Create variant objects from groupedData object
groupedData2table	Convert groupedData object to table

Examples

Create groupedData from Existing Data Set

Load the sample data set.

load pheno.mat ds

Create a groupedData object from the data set ds.

grpData = groupedData(ds);

Display the object properties.

grpData.Properties

ans = struct with fields:
                Description: ''
                   UserData: []
             DimensionNames: {'Observations'  'Variables'}
              VariableNames: {'ID'  'TIME'  'DOSE'  'WEIGHT'  'APGAR'  'CONC'}
              VariableTypes: ["double"    "double"    "double"    "double"    "double"    "double"]
       VariableDescriptions: {}
              VariableUnits: {}
         VariableContinuity: []
                   RowNames: {}
           CustomProperties: [1×1 matlab.tabular.CustomProperties]
          GroupVariableName: 'ID'
    IndependentVariableName: 'TIME'

GroupVariableName and IndpendentVariableName have been automatically assigned to 'ID' and 'Time', respectively.

Version History

Introduced in R2014a