bd_getdata: Create an input object from a blooddata object.

View source: R/kinfitr_blooddata.R

bd_getdataR Documentation

Create an input object from a blooddata object.

Description

DEPRECATION WARNING: this function will be slowly phased out of future releases as it is based on the old PET BIDS standard. in favour of bd_extract() and bd_create_input(). blooddata objects can be updated to the new format using update_blooddata(), or (better) by creating it afresh from the source.

Usage

bd_getdata(
  blooddata,
  startTime = 0,
  stopTime = NULL,
  interpPoints = 6000,
  output = c("input", "Blood", "BPR", "parentFraction", "AIF")
)

Arguments

blooddata

A blooddata object, to which all the desired fits have been applied and added.

startTime

The starting time for the interpolation. Defaults to zero. If, after application of the TimeShift value in the blooddata object, the startTime is still after zero, it will be set to zero.

stopTime

The end time for the interpolation. Defaults to the maximum measured time.

interpPoints

The number of points to interpolate over between the start and stop times.

output

The output. This defaults to an "input" object, which can be used in a kinetic model fit. But if set to "Blood", "BPR", "parentFraction" or "AIF", it yields the appropriate input for the function which will be used to model these.

Details

This function extracts data from blooddata objects to create either an input object for kinetic modelling, or sets of values for modelling of blood-related curves.

Value

A tibble containing the output specified.

Author(s)

Granville J Matheson, mathesong@gmail.com

Examples

## Not run: 
bd_getdata(blooddata)
bd_getdata(blooddata, output = "parentFraction")

## End(Not run)

mathesong/kinfitr documentation built on Jan. 15, 2024, 11:07 p.m.