PKData

Define roles of dataset columns

Description

The properties of the PKData object specify what each column in the data represents.

The PKData object specifies which columns in the data set represent the following:

• The grouping variable

• The independent and dependent variables

• The dose

• The rate (only if infusion is the dosing type)

• The covariates

This information is used by the fitting functions, sbionlmefit and sbionlinfit.

The PKData class is a subclass of the hgsetget class, which is a subclass of the handle class. For more information on the inherited methods, see hgsetget and handle.

Creation

Syntax

PKDataObj = PKData(data)

Description

PKDataObj = PKData(data) creates a PKData object from an input data.

Input Arguments

data — Input data

dataset object

Input data, specified as a dataset object.

Properties

CovariateLabels — Identification of covariate columns in dataset

{} (default) | character vector | string scalar | string vector | cell array of character vectors

Identification of covariate columns in the dataset, specified as a character vector, string scalar, string vector, or cell array of character vectors.

Specify one or more names of the covariate columns in the input dataset.

Data Types: char | string | cell

Dataset — Input dataset

dataset object

This property is read-only.

Input dataset, specified as a dataset object.

DependentVarLabel — Names of dependent variable columns

{} (default) | character vector | string scalar | string vector | cell array of character vectors

Names of dependent variable columns in the dataset, specified as a character vector, string scalar, string vector, or cell array of character vectors.

The property specifies the columns in the input dataset that contain the dependent variables, for example, measured responses. The column must contain numeric values, and cannot contain Inf or –Inf.

Data Types: char | string | cell

DependentVarUnits — Units for dependent variables

{} (default) | character vector | string scalar | string vector | cell array of character vectors

Units for dependent variables, specified as a character vector, string scalar, string vector, or cell array of character vectors.

Specify units from the units library. To get a list of units, use sbioshowunits.

If there are no units associated with the dependent variables in your data set, you can set this property to a cell array of empty character vectors, or simply an empty cell array.

Data Types: char | string | cell

DoseLabel — Names of dose columns in dataset

{} (default) | character vector | string scalar | string vector | cell array of character vectors

Names of dose columns in the input dataset, specified as a character vector, string scalar, string vector, or cell array of character vectors.

The column must contain positive values, and cannot contain Inf or –Inf.

Data Types: char | string | cell

DoseUnits — Units for dose columns

{} (default) | character vector | string scalar | string vector | cell array of character vectors

Units for dose columns, specified as a character vector, string scalar, string vector, or cell array of character vectors.

Dose units must have dimensions of amount or mass. The length of DoseUnits must be the same as DoseLabel. For example, if the DoseLabel property defines two columns containing dosing information, DoseUnits must also define units for both columns. If unit conversion is on, dose and rate units must be consistent with each other (that is in terms of amount or mass) and must be consistent with the species object that is being dosed.

Specify units from the units library. To get a list of units, use sbioshowunits.

Data Types: char | string | cell

GroupID — Index value for each group in dataset

numeric array

This property is read-only.

Index value for each group in the input dataset, specified as a numeric array.

It is an array of the same length as the DataSet property containing an integer to identify each group. PKData sets this property during construction of the PKData object based on the input dataset.

Data Types: double

GroupLabel — Name of column containing group identification labels

'' (default) | character vector | string scalar

Name of the column containing group identification labels, specified as a character vector or string scalar.

Data Types: char | string

GroupNames — Unique values from GroupLabel in dataset

character vector | string scalar | string vector | cell array of character vectors

This property is read-only.

Unique values from the data column specified by the GroupLabel property, specified as a character vector, string scalar, string vector, or cell array of character vectors.

Data Types: char | string | cell

IndependentVarLabel — Name of independent variable column

'' (default) | character vector | string scalar

Name of the independent variable column, such as a time column, in the input dataset, specified as a character vector or string scalar.

The column must contain positive values, and cannot contain, NaN, Inf or –Inf.

Data Types: char | string

IndependentVarUnits — Units for independent variable column

'' (default) | character vector | string scalar

Units for the independent variable column, specified as a character vector or string scalar.

Specify units from the units library. To get a list of units, use sbioshowunits.

Data Types: char | string

RateLabel — Name of infusion rate column

{} (default) | character vector | string scalar

Name of the infusion rate column, specified as a character vector or string scalar.

The infusion rate column applies only when the dosing type is infusion. The dataset must contain the rate and not an infusion time. The values must be positive and the column cannot contain Inf or –Inf. 0 specifies an infinite rate (equivalent to a bolus dose), and NaN specifies no rate.

Data Types: char | string

RateUnits — Units for dose rate

{} (default) | character vector | string scalar

Units for the dose rate, specified as a character vector or string scalar.

For additional details, see RateUnits.

Data Types: char | string

Object Functions

delete	Delete SimBiology object
display	Display summary of SimBiology object
get	Get SimBiology object properties
getCovariateData	Create design matrix needed for fit
set	Set SimBiology object properties

Version History

Introduced in R2009a