PKData object

Define roles of data set columns

PKData object will be removed in a future release. Use groupedData object instead.

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.

To create the PKData object specify:

pkDataObject = PKData(data);

Where data is the imported data set.

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.

Construction

PKDataCreate PKData object

Method Summary

get (any object)Get object properties
getCovariateData (pkdata)Create design matrix needed for fit
set (any object)Set object properties

Property Summary

CovariateLabelsIdentify covariate columns in data set
DataSetDataset object containing imported data
DependentVarLabelIdentify dependent variable column in data set
DependentVarUnitsResponse units in PKData object
DoseLabelDose column in data set
DoseUnitsDose units in PKData object
GroupIDInteger identifying each group in data set
GroupLabelIdentify group column in data set
GroupNamesUnique values from GroupLabel in data set
IndependentVarLabelIdentify independent variable column in data set
IndependentVarUnitsTime units in PKData object
RateLabelRate of infusion column in data set
RateUnitsUnits for dose rate

See Also

Specify and Classify the Data to Fit in the SimBiology® User's Guide, PKModelDesign object

Was this topic helpful?